# Search locations by keyword. Find locations by keyword with EnvoAPI. Retrieve matching location names and Envo IDs to use in supported search filters. `GET https://api.envoapi.com/v1/search/locations` Operation ID: `searchLocationsByKeyword` ## Authentication See [Authentication](https://docs.envoapi.com/guides/authentication.md). Security alternatives (each object is one alternative): ```json [ { "BearerApiKey": [] } ] ``` BearerApiKey: ```json { "type": "http", "scheme": "bearer", "bearerFormat": "envo_<66 Base64url characters>" } ``` ## Credits Uses the current Profile base Credit cost. Check your dashboard for current costs; example charges are illustrative. ## Parameters ### keywords Location: query. Required: yes. Schema: {"type":"string","minLength":1,"maxLength":500} Example: ```json "United States" ``` ## Request example ```bash curl "https://api.envoapi.com/v1/search/locations?keywords=United+States" \ --header "Authorization: Bearer $ENVO_API_KEY" \ --header "Accept: application/json" ``` ## Responses ### 200 Matching locations and their Envo IDs. * **Date**: Required response header. Schema: [HttpDateHeader](https://docs.envoapi.com/api/schemas/HttpDateHeader.md). * **Cache-Control**: Do not cache the reply. Schema: [CacheControlHeader](https://docs.envoapi.com/api/schemas/CacheControlHeader.md). * **X-Request-Id**: A unique ID for this call. Quote it if you contact support. Schema: [RequestId](https://docs.envoapi.com/api/schemas/RequestId.md). * **X-Credits-Remaining**: Credits left on your account after this call. Schema: [NonNegativeSafeInteger](https://docs.envoapi.com/api/schemas/NonNegativeSafeInteger.md). * **X-RateLimit-Limit**: The Account's current rolling request ceiling. Schema: [NonNegativeSafeInteger](https://docs.envoapi.com/api/schemas/NonNegativeSafeInteger.md). * **X-RateLimit-Remaining**: Requests remaining in the current rolling window. Schema: [NonNegativeSafeInteger](https://docs.envoapi.com/api/schemas/NonNegativeSafeInteger.md). * **X-RateLimit-Reset**: Whole seconds until capacity resets, rounded up. Schema: [NonNegativeSafeInteger](https://docs.envoapi.com/api/schemas/NonNegativeSafeInteger.md). Content type: `application/json`. Schema: [LinkedInV2LocationSearchSuccess](https://docs.envoapi.com/api/schemas/LinkedInV2LocationSearchSuccess.md) | Field | Required | Schema | Description | | --------------- | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------- | | data | yes | [LocationSearchData](https://docs.envoapi.com/api/schemas/LocationSearchData.md) | The result of the call. Fields we cannot fill are null. | | data.locations | yes (when parent present) | {"maxItems":50,"type":"array","items":{"$ref":"#/components/schemas/LocationSearchLocation"}} | | | meta | yes | {"type":"object","properties":{"creditCost":{"$ref":"#/components/schemas/NonNegativeSafeInteger"}},"required":\["creditCost"],"additionalProperties":false} | Information about the call itself. | | meta.creditCost | yes (when parent present) | [NonNegativeSafeInteger](https://docs.envoapi.com/api/schemas/NonNegativeSafeInteger.md) | How many credits this call used. | Response example: ```json { "data": { "locations": [ { "id": "geo_6yITcz", "name": "United States" }, { "id": "geo_7wDtAj", "name": "Washington DC-Baltimore Area" }, { "id": "geo_4PovMp", "name": "District of Columbia, United States" }, { "id": "geo_6c4TtQ", "name": "Washington, DC" }, { "id": "geo_2gc1uY", "name": "California, United States" } ] }, "meta": { "creditCost": 1 } } ``` ### 400 A request parameter is missing or invalid. A parameter is missing or has a value we cannot use. Read error.details, fix the value and try again. * **Date**: Required response header. Schema: [HttpDateHeader](https://docs.envoapi.com/api/schemas/HttpDateHeader.md). * **Cache-Control**: Do not cache the reply. Schema: [CacheControlHeader](https://docs.envoapi.com/api/schemas/CacheControlHeader.md). * **X-Request-Id**: A unique ID for this call. Quote it if you contact support. Schema: [RequestId](https://docs.envoapi.com/api/schemas/RequestId.md). * **Content-Type**: Required response header. Schema: {"type":"string","const":"application/json; charset=utf-8"}. Content type: `application/json`. Schema: [InvalidRequestErrorResponse](https://docs.envoapi.com/api/schemas/InvalidRequestErrorResponse.md) ### 401 Your API key is invalid or inactive. Your API key is missing, wrong or switched off. Check it in your dashboard. * **Date**: Required response header. Schema: [HttpDateHeader](https://docs.envoapi.com/api/schemas/HttpDateHeader.md). * **Cache-Control**: Do not cache the reply. Schema: [CacheControlHeader](https://docs.envoapi.com/api/schemas/CacheControlHeader.md). * **X-Request-Id**: A unique ID for this call. Quote it if you contact support. Schema: [RequestId](https://docs.envoapi.com/api/schemas/RequestId.md). * **Content-Type**: Required response header. Schema: {"type":"string","const":"application/json; charset=utf-8"}. Content type: `application/json`. Schema: [InvalidApiKeyErrorResponse](https://docs.envoapi.com/api/schemas/InvalidApiKeyErrorResponse.md) ### 402 Your account does not have enough credits. Your account has no credits left. Top up, then send a new call. * **Date**: Required response header. Schema: [HttpDateHeader](https://docs.envoapi.com/api/schemas/HttpDateHeader.md). * **Cache-Control**: Do not cache the reply. Schema: [CacheControlHeader](https://docs.envoapi.com/api/schemas/CacheControlHeader.md). * **X-Request-Id**: A unique ID for this call. Quote it if you contact support. Schema: [RequestId](https://docs.envoapi.com/api/schemas/RequestId.md). * **Content-Type**: Required response header. Schema: {"type":"string","const":"application/json; charset=utf-8"}. * **X-Credits-Remaining**: Credits left on your account after this call. Schema: [NonNegativeSafeInteger](https://docs.envoapi.com/api/schemas/NonNegativeSafeInteger.md). * **X-RateLimit-Limit**: The Account's current rolling request ceiling. Schema: [NonNegativeSafeInteger](https://docs.envoapi.com/api/schemas/NonNegativeSafeInteger.md). * **X-RateLimit-Remaining**: Requests remaining in the current rolling window. Schema: [NonNegativeSafeInteger](https://docs.envoapi.com/api/schemas/NonNegativeSafeInteger.md). * **X-RateLimit-Reset**: Whole seconds until capacity resets, rounded up. Schema: [NonNegativeSafeInteger](https://docs.envoapi.com/api/schemas/NonNegativeSafeInteger.md). Content type: `application/json`. Schema: [InsufficientCreditsErrorResponse](https://docs.envoapi.com/api/schemas/InsufficientCreditsErrorResponse.md) ### 403 Your API key or account cannot access this endpoint. Your account is suspended or cannot use this endpoint. Resolve the account or its access first. * **Date**: Required response header. Schema: [HttpDateHeader](https://docs.envoapi.com/api/schemas/HttpDateHeader.md). * **Cache-Control**: Do not cache the reply. Schema: [CacheControlHeader](https://docs.envoapi.com/api/schemas/CacheControlHeader.md). * **X-Request-Id**: A unique ID for this call. Quote it if you contact support. Schema: [RequestId](https://docs.envoapi.com/api/schemas/RequestId.md). * **Content-Type**: Required response header. Schema: {"type":"string","const":"application/json; charset=utf-8"}. Content type: `application/json`. Schema: [LookupForbiddenErrorResponse](https://docs.envoapi.com/api/schemas/LookupForbiddenErrorResponse.md) ### 404 The requested resource was not found. Nothing matched what you sent. Check it for typos. * **Date**: Required response header. Schema: [HttpDateHeader](https://docs.envoapi.com/api/schemas/HttpDateHeader.md). * **Cache-Control**: Do not cache the reply. Schema: [CacheControlHeader](https://docs.envoapi.com/api/schemas/CacheControlHeader.md). * **X-Request-Id**: A unique ID for this call. Quote it if you contact support. Schema: [RequestId](https://docs.envoapi.com/api/schemas/RequestId.md). * **Content-Type**: Required response header. Schema: {"type":"string","const":"application/json; charset=utf-8"}. * **X-Credits-Remaining**: Credits left on your account after this call. Schema: [NonNegativeSafeInteger](https://docs.envoapi.com/api/schemas/NonNegativeSafeInteger.md). * **X-RateLimit-Limit**: The Account's current rolling request ceiling. Schema: [NonNegativeSafeInteger](https://docs.envoapi.com/api/schemas/NonNegativeSafeInteger.md). * **X-RateLimit-Remaining**: Requests remaining in the current rolling window. Schema: [NonNegativeSafeInteger](https://docs.envoapi.com/api/schemas/NonNegativeSafeInteger.md). * **X-RateLimit-Reset**: Whole seconds until capacity resets, rounded up. Schema: [NonNegativeSafeInteger](https://docs.envoapi.com/api/schemas/NonNegativeSafeInteger.md). Content type: `application/json`. Schema: [ResourceNotFoundErrorResponse](https://docs.envoapi.com/api/schemas/ResourceNotFoundErrorResponse.md) ### 405 Use GET for this endpoint. The route exists, but the request used a method other than GET. Use the method shown at the top of this page. * **Date**: Required response header. Schema: [HttpDateHeader](https://docs.envoapi.com/api/schemas/HttpDateHeader.md). * **Cache-Control**: Do not cache the reply. Schema: [CacheControlHeader](https://docs.envoapi.com/api/schemas/CacheControlHeader.md). * **X-Request-Id**: A unique ID for this call. Quote it if you contact support. Schema: [RequestId](https://docs.envoapi.com/api/schemas/RequestId.md). * **Content-Type**: Required response header. Schema: {"type":"string","const":"application/json; charset=utf-8"}. * **Allow**: Required response header. Schema: {"type":"string","const":"GET"}. Content type: `application/json`. Schema: [MethodNotAllowedErrorResponse](https://docs.envoapi.com/api/schemas/MethodNotAllowedErrorResponse.md) ### 406 The response format in your Accept header is not supported. The Accept header asks for a format we do not send. Ask for JSON with a supported Accept value. * **Date**: Required response header. Schema: [HttpDateHeader](https://docs.envoapi.com/api/schemas/HttpDateHeader.md). * **Cache-Control**: Do not cache the reply. Schema: [CacheControlHeader](https://docs.envoapi.com/api/schemas/CacheControlHeader.md). * **X-Request-Id**: A unique ID for this call. Quote it if you contact support. Schema: [RequestId](https://docs.envoapi.com/api/schemas/RequestId.md). * **Content-Type**: Required response header. Schema: {"type":"string","const":"application/json; charset=utf-8"}. Content type: `application/json`. Schema: [NotAcceptableErrorResponse](https://docs.envoapi.com/api/schemas/NotAcceptableErrorResponse.md) ### 415 The Content-Type in your request is not supported. The request declared a media type we do not accept. Remove the body or use the documented media type. * **Date**: Required response header. Schema: [HttpDateHeader](https://docs.envoapi.com/api/schemas/HttpDateHeader.md). * **Cache-Control**: Do not cache the reply. Schema: [CacheControlHeader](https://docs.envoapi.com/api/schemas/CacheControlHeader.md). * **X-Request-Id**: A unique ID for this call. Quote it if you contact support. Schema: [RequestId](https://docs.envoapi.com/api/schemas/RequestId.md). * **Content-Type**: Required response header. Schema: {"type":"string","const":"application/json; charset=utf-8"}. Content type: `application/json`. Schema: [UnsupportedMediaTypeErrorResponse](https://docs.envoapi.com/api/schemas/UnsupportedMediaTypeErrorResponse.md) ### 429 Your account has sent too many requests. Too many calls in a short time. Honor Retry-After; use bounded retries with backoff and jitter. * **Date**: Required response header. Schema: [HttpDateHeader](https://docs.envoapi.com/api/schemas/HttpDateHeader.md). * **Cache-Control**: Do not cache the reply. Schema: [CacheControlHeader](https://docs.envoapi.com/api/schemas/CacheControlHeader.md). * **X-Request-Id**: A unique ID for this call. Quote it if you contact support. Schema: [RequestId](https://docs.envoapi.com/api/schemas/RequestId.md). * **Content-Type**: Required response header. Schema: {"type":"string","const":"application/json; charset=utf-8"}. * **X-RateLimit-Limit**: The Account's current rolling request ceiling. Schema: [NonNegativeSafeInteger](https://docs.envoapi.com/api/schemas/NonNegativeSafeInteger.md). * **X-RateLimit-Remaining**: Requests remaining in the current rolling window. Schema: [NonNegativeSafeInteger](https://docs.envoapi.com/api/schemas/NonNegativeSafeInteger.md). * **X-RateLimit-Reset**: Whole seconds until capacity resets, rounded up. Schema: [NonNegativeSafeInteger](https://docs.envoapi.com/api/schemas/NonNegativeSafeInteger.md). * **Retry-After**: Seconds to wait before you try again. Schema: [PositiveSafeInteger](https://docs.envoapi.com/api/schemas/PositiveSafeInteger.md). Content type: `application/json`. Schema: [RateLimitExceededErrorResponse](https://docs.envoapi.com/api/schemas/RateLimitExceededErrorResponse.md) ### 500 A server error prevented the request from completing. Something failed on our side. Retry only when error.retryable is true. * **Date**: Required response header. Schema: [HttpDateHeader](https://docs.envoapi.com/api/schemas/HttpDateHeader.md). * **Cache-Control**: Do not cache the reply. Schema: [CacheControlHeader](https://docs.envoapi.com/api/schemas/CacheControlHeader.md). * **X-Request-Id**: A unique ID for this call. Quote it if you contact support. Schema: [RequestId](https://docs.envoapi.com/api/schemas/RequestId.md). * **Content-Type**: Required response header. Schema: {"type":"string","const":"application/json; charset=utf-8"}. * **X-Credits-Remaining**: Credits left on your account after this call. Schema: [NonNegativeSafeInteger](https://docs.envoapi.com/api/schemas/NonNegativeSafeInteger.md). * **X-RateLimit-Limit**: The Account's current rolling request ceiling. Schema: [NonNegativeSafeInteger](https://docs.envoapi.com/api/schemas/NonNegativeSafeInteger.md). * **X-RateLimit-Remaining**: Requests remaining in the current rolling window. Schema: [NonNegativeSafeInteger](https://docs.envoapi.com/api/schemas/NonNegativeSafeInteger.md). * **X-RateLimit-Reset**: Whole seconds until capacity resets, rounded up. Schema: [NonNegativeSafeInteger](https://docs.envoapi.com/api/schemas/NonNegativeSafeInteger.md). Content type: `application/json`. Schema: [InternalServerErrorResponse](https://docs.envoapi.com/api/schemas/InternalServerErrorResponse.md) ### 502 A data source returned an invalid response. A data source sent back something we could not use. Retry with bounded backoff. * **Date**: Required response header. Schema: [HttpDateHeader](https://docs.envoapi.com/api/schemas/HttpDateHeader.md). * **Cache-Control**: Do not cache the reply. Schema: [CacheControlHeader](https://docs.envoapi.com/api/schemas/CacheControlHeader.md). * **X-Request-Id**: A unique ID for this call. Quote it if you contact support. Schema: [RequestId](https://docs.envoapi.com/api/schemas/RequestId.md). * **Content-Type**: Required response header. Schema: {"type":"string","const":"application/json; charset=utf-8"}. * **X-Credits-Remaining**: Credits left on your account after this call. Schema: [NonNegativeSafeInteger](https://docs.envoapi.com/api/schemas/NonNegativeSafeInteger.md). * **X-RateLimit-Limit**: The Account's current rolling request ceiling. Schema: [NonNegativeSafeInteger](https://docs.envoapi.com/api/schemas/NonNegativeSafeInteger.md). * **X-RateLimit-Remaining**: Requests remaining in the current rolling window. Schema: [NonNegativeSafeInteger](https://docs.envoapi.com/api/schemas/NonNegativeSafeInteger.md). * **X-RateLimit-Reset**: Whole seconds until capacity resets, rounded up. Schema: [NonNegativeSafeInteger](https://docs.envoapi.com/api/schemas/NonNegativeSafeInteger.md). Content type: `application/json`. Schema: [UpstreamErrorResponse](https://docs.envoapi.com/api/schemas/UpstreamErrorResponse.md) ### 503 The service is unavailable. Check error.retryable before retrying. Lookups are unavailable for a moment. Follow error.retryable, and Retry-After when it is present. * **Date**: Required response header. Schema: [HttpDateHeader](https://docs.envoapi.com/api/schemas/HttpDateHeader.md). * **Cache-Control**: Do not cache the reply. Schema: [CacheControlHeader](https://docs.envoapi.com/api/schemas/CacheControlHeader.md). * **X-Request-Id**: A unique ID for this call. Quote it if you contact support. Schema: [RequestId](https://docs.envoapi.com/api/schemas/RequestId.md). * **Content-Type**: Required response header. Schema: {"type":"string","const":"application/json; charset=utf-8"}. * **Retry-After**: Seconds to wait before you try again. Schema: [NonNegativeSafeInteger](https://docs.envoapi.com/api/schemas/NonNegativeSafeInteger.md). * **X-RateLimit-Limit**: The Account's current rolling request ceiling. Schema: [NonNegativeSafeInteger](https://docs.envoapi.com/api/schemas/NonNegativeSafeInteger.md). * **X-RateLimit-Remaining**: Requests remaining in the current rolling window. Schema: [NonNegativeSafeInteger](https://docs.envoapi.com/api/schemas/NonNegativeSafeInteger.md). * **X-RateLimit-Reset**: Whole seconds until capacity resets, rounded up. Schema: [NonNegativeSafeInteger](https://docs.envoapi.com/api/schemas/NonNegativeSafeInteger.md). * **X-Credits-Remaining**: Credits left on your account after this call. Schema: [NonNegativeSafeInteger](https://docs.envoapi.com/api/schemas/NonNegativeSafeInteger.md). Content type: `application/json`. Schema: [ServiceUnavailableErrorResponse](https://docs.envoapi.com/api/schemas/ServiceUnavailableErrorResponse.md) ### 504 The request timed out. The lookup ran out of time. Retry with bounded backoff. * **Date**: Required response header. Schema: [HttpDateHeader](https://docs.envoapi.com/api/schemas/HttpDateHeader.md). * **Cache-Control**: Do not cache the reply. Schema: [CacheControlHeader](https://docs.envoapi.com/api/schemas/CacheControlHeader.md). * **X-Request-Id**: A unique ID for this call. Quote it if you contact support. Schema: [RequestId](https://docs.envoapi.com/api/schemas/RequestId.md). * **Content-Type**: Required response header. Schema: {"type":"string","const":"application/json; charset=utf-8"}. * **X-Credits-Remaining**: Credits left on your account after this call. Schema: [NonNegativeSafeInteger](https://docs.envoapi.com/api/schemas/NonNegativeSafeInteger.md). * **X-RateLimit-Limit**: The Account's current rolling request ceiling. Schema: [NonNegativeSafeInteger](https://docs.envoapi.com/api/schemas/NonNegativeSafeInteger.md). * **X-RateLimit-Remaining**: Requests remaining in the current rolling window. Schema: [NonNegativeSafeInteger](https://docs.envoapi.com/api/schemas/NonNegativeSafeInteger.md). * **X-RateLimit-Reset**: Whole seconds until capacity resets, rounded up. Schema: [NonNegativeSafeInteger](https://docs.envoapi.com/api/schemas/NonNegativeSafeInteger.md). Content type: `application/json`. Schema: [UpstreamTimeoutErrorResponse](https://docs.envoapi.com/api/schemas/UpstreamTimeoutErrorResponse.md) ## Related documentation * [Authentication](https://docs.envoapi.com/guides/authentication.md) * [Errors](https://docs.envoapi.com/guides/errors.md) * [Pagination](https://docs.envoapi.com/guides/pagination.md) * [Rate limits](https://docs.envoapi.com/guides/rate-limits.md) * [Find companies by website domain.](https://docs.envoapi.com/api/operations/searchcompaniesbydomain.md) * [Search companies by keyword.](https://docs.envoapi.com/api/operations/searchcompaniesbykeyword.md) * [Search schools by keyword.](https://docs.envoapi.com/api/operations/searchschoolsbykeyword.md) * [Search service providers by keyword.](https://docs.envoapi.com/api/operations/searchservicesbykeyword.md) * [Search people by keyword.](https://docs.envoapi.com/api/operations/searchpeoplebykeyword.md) * [Search all result types by keyword.](https://docs.envoapi.com/api/operations/searchallresultsbykeyword.md) * [Search industries by keyword.](https://docs.envoapi.com/api/operations/searchindustriesbykeyword.md) * [Search service categories.](https://docs.envoapi.com/api/operations/searchservicecategories.md) * [Get search suggestions.](https://docs.envoapi.com/api/operations/getsearchtypeahead.md) [Documentation index](https://docs.envoapi.com/llms.txt) ยท [All endpoints](https://docs.envoapi.com/api/index.md)