# Search people by keyword. Search profiles by keyword with EnvoAPI. Filter by location, company, school, language or industry and paginate through matching people. `GET https://api.envoapi.com/v1/profiles/search` Operation ID: `searchPeopleByKeyword` ## 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":120} Example: ```json "Satya Nadella" ``` ### location Location: query. Required: no. Schema: {"type":"string","minLength":1,"maxLength":1099,"description":"Location IDs from [Location search](https://docs.envoapi.com/api/operations/searchlocationsbykeyword.md) (`data.locations[].id`). Separate IDs with commas."} Example: ```json "geo_6yITcz" ``` ### currentCompany Location: query. Required: no. Schema: {"type":"string","minLength":1,"maxLength":1099,"description":"Filter by current employer. Use IDs from [Company details](https://docs.envoapi.com/api/operations/getcompanydetailsbyslug.md) (`data.publicId`), separated by commas. Find companies with [Company search](https://docs.envoapi.com/api/operations/searchcompaniesbykeyword.md)."} Example: ```json "company_4T4tWj" ``` ### pastCompany Location: query. Required: no. Schema: {"type":"string","minLength":1,"maxLength":1099,"description":"Filter by past employer. Use IDs from [Company details](https://docs.envoapi.com/api/operations/getcompanydetailsbyslug.md) (`data.publicId`), separated by commas. Find companies with [Company search](https://docs.envoapi.com/api/operations/searchcompaniesbykeyword.md)."} Example: ```json "company_4T4tWj" ``` ### schoolFilter Location: query. Required: no. Schema: {"type":"string","minLength":1,"maxLength":1099,"description":"School IDs from [School search](https://docs.envoapi.com/api/operations/searchschoolsbykeyword.md) (`data.schools[].id`). Separate IDs with commas."} Example: ```json "school_55rBxU" ``` ### profileLanguage Location: query. Required: no. Schema: {"type":"string","minLength":1,"maxLength":1099,"description":"Profile language codes, separated by commas: cs, da, de, en, es, fr, in, it, ja, ko, ms, nl, no, pl, pt, ro, ru, sv, tr, zh, \_o. Use in for Indonesian, zh for Chinese, and \_o for other profile languages."} Example: ```json "en" ``` ### serviceCategory Location: query. Required: no. Schema: {"type":"string","minLength":1,"maxLength":1099,"description":"Category IDs from [Service category search](https://docs.envoapi.com/api/operations/searchservicecategories.md) (`data.serviceCategories[].id`). Separate IDs with commas."} Example: ```json "service_AuaLW4,service_17C5pg" ``` ### industry Location: query. Required: no. Schema: {"type":"string","minLength":1,"maxLength":1099,"description":"Industry IDs from [Industry search](https://docs.envoapi.com/api/operations/searchindustriesbykeyword.md) (`data.industries[].id`). Separate IDs with commas."} Example: ```json "industry_C1dRf" ``` ### offset Location: query. Required: no. Schema: {"default":0,"type":"integer","minimum":0,"maximum":50} Example: ```json 0 ``` ## Request example ```bash curl "https://api.envoapi.com/v1/profiles/search?keywords=Satya+Nadella&offset=0&profileLanguage=en" \ --header "Authorization: Bearer $ENVO_API_KEY" \ --header "Accept: application/json" ``` ## Responses ### 200 Profiles matching the keywords. * **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: [PeopleKeywordSearchSuccess](https://docs.envoapi.com/api/schemas/PeopleKeywordSearchSuccess.md) | Field | Required | Schema | Description | | --------------- | ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- | | data | yes | [PeopleKeywordSearchData](https://docs.envoapi.com/api/schemas/PeopleKeywordSearchData.md) | The result of the call. Fields we cannot fill are null. | | data.profiles | yes (when parent present) | {"maxItems":10,"type":"array","items":{"$ref":"#/components/schemas/PeopleKeywordSearchProfile"}} | | | meta | yes | {"type":"object","properties":{"paging":{"$ref":"#/components/schemas/CompanyDomainSearchPaging"},"creditCost":{"$ref":"#/components/schemas/NonNegativeSafeInteger"}},"required":\["paging","creditCost"],"additionalProperties":false} | Information about the call itself. | | meta.paging | yes (when parent present) | [CompanyDomainSearchPaging](https://docs.envoapi.com/api/schemas/CompanyDomainSearchPaging.md) | | | 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": { "profiles": [ { "publicId": "profile_fcIPmKVujqone1EW9RvwKknbNbBl4jzhXnTmNYg", "name": "sathya fake nadella", "firstName": "sathya", "lastName": "fake nadella", "headline": "Student at indumathi engineering science college", "summary": null, "location": "Erode, Tamil Nadu, India", "countryISOCode": "IN", "industry": null, "linkedinUrl": "https://www.linkedin.com/in/sathya-fake-nadella-138aba125", "profilePictureUrl": null, "positions": [], "education": [ { "schoolName": "indumathi engineering science college", "degreeName": null, "fieldOfStudy": null, "dateRange": { "start": { "year": 2013, "month": null, "day": null }, "end": { "year": 2017, "month": null, "day": null }, "isCurrent": false } } ], "skills": [], "premium": false, "creator": false, "influencer": false }, { "publicId": "profile_8yGkIEo62RJh5NCKgLPWAZDpgKynBOneB1utalS", "name": "Paul ๐Ÿ˜Š", "firstName": "Paul", "lastName": "๐Ÿ˜Š", "headline": "Co-Founder at Surfy", "summary": "Technology, earth and space are my interests. I strive to use data science to explore and uncover fun and interesting insights that deepen our understanding of the unknown. Curiosity is my motivation and I always have a new side project that's unique and fun. I enjoy getting outside and enjoying the sun by hiking or cycling. I also love exploring datasets and seeing what correlations I can uncover.", "location": "Kaneohe, Hawaii, United States", "countryISOCode": "US", "industry": "Information Technology & Services", "linkedinUrl": "https://www.linkedin.com/in/devin-lacrosse", "profilePictureUrl": "https://image.envoapi.com/search-people-by-keyword/image-1.jpg", "positions": [ { "title": "Co-Founder", "companyName": "Surfy", "location": "Honolulu, HI", "description": "An elite surf organization dedicated to paddling out, missing waves, talking about conditions like we know what weโ€™re doing, and occasionally catching something decent", "dateRange": { "start": { "year": 2025, "month": 11, "day": null }, "end": null, "isCurrent": true } }, { "title": "Super special senior lead Gen. AI AGI Dojo Master", "companyName": "Booz Allen Hamilton", "location": "United States", "description": "I build stuff for people! ๐Ÿ’€๐Ÿ“Š๐Ÿ‡บ๐Ÿ‡ธ๐ŸŒŽ", "dateRange": { "start": { "year": 2021, "month": 6, "day": null }, "end": null, "isCurrent": true } }, { "title": "Linkedin joker ๐Ÿƒ", "companyName": "Naval Undersea Warfare Center Division, Keyport", "location": null, "description": "Wrote code, the old school way! โŒจ๏ธ", "dateRange": { "start": { "year": 2017, "month": 2, "day": null }, "end": { "year": 2021, "month": 6, "day": null }, "isCurrent": false } }, { "title": "Chief software assistant to Satya Nadella", "companyName": "Microsoft", "location": "Greater Seattle Area", "description": "๐Ÿ’ฌ talked to supervisors", "dateRange": { "start": { "year": 2017, "month": 3, "day": null }, "end": { "year": 2017, "month": 11, "day": null }, "isCurrent": false } }, { "title": "Software Developer", "companyName": "Maura Software", "location": "Rexburg, Idaho", "description": "The blind leading the blind ๐Ÿ˜ฌ", "dateRange": { "start": { "year": 2016, "month": 4, "day": null }, "end": { "year": 2016, "month": 8, "day": null }, "isCurrent": false } } ], "education": [ { "schoolName": "Georgia Institute of Technology", "degreeName": "Master's degree", "fieldOfStudy": "Data Analytics", "dateRange": { "start": { "year": 2020, "month": 1, "day": null }, "end": { "year": 2027, "month": 12, "day": null }, "isCurrent": false } }, { "schoolName": "Brigham Young University - Idaho", "degreeName": "Bachelor's degree", "fieldOfStudy": "Computer Science extra courses in: artificial intelligence, machine learning and data mining", "dateRange": { "start": { "year": 2012, "month": null, "day": null }, "end": { "year": 2015, "month": null, "day": null }, "isCurrent": false } } ], "skills": [ "๐ŸŒŠ wiping out", "๐ŸŠโ€โ™‚๏ธ drowning", "๐Ÿ”ซ nerf gun fights", "๐ŸŽ‰ got along with colleagues", "๐Ÿ” ate good food", "๐Ÿ…ฟ๏ธ found parking regularly", "๐ŸšŒ fought rush hour traffic", "โŒจ๏ธKeyboarding", "๐Ÿšถlunch walks", "๐Ÿคฌ working with colleagues", "โœ… going to work!", "๐Ÿ—ฃ๏ธtalking to people", "โฐ reporting time correctly", "๐Ÿ“ง writting emails", "๐Ÿ“ writing emails", "๐Ÿ’ปsigning into many different email accounts", "โ˜•๏ธ getting coffee", "๐Ÿ’ฌ dmโ€™ing colleagues on Teams", "Acoustic Guitar", "Guitar Playing" ], "premium": false, "creator": false, "influencer": false }, { "publicId": "profile_1rZ07AMN6MItbSvQwBxrBXW2TVXX2B0SORta15J", "name": "Krishna Jyothi Nadella", "firstName": "Krishna Jyothi", "lastName": "Nadella", "headline": "Asst. Professor in Physics at Sri Satya Sai University for Human Excellence", "summary": null, "location": "Chikkaballapura, Karnataka, India", "countryISOCode": "IN", "industry": "Education Management", "linkedinUrl": "https://www.linkedin.com/in/krishna-jyothi-nadella-668511200", "profilePictureUrl": null, "positions": [ { "title": "Asst. Professor of Physics", "companyName": "Sri Satya Sai University for Human Excellence", "location": null, "description": null, "dateRange": null } ], "education": [], "skills": [], "premium": false, "creator": false, "influencer": false } ] }, "meta": { "paging": { "offset": 0, "limit": 3, "returned": 3, "hasMore": true, "nextOffset": 3 }, "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 all result types by keyword.](https://docs.envoapi.com/api/operations/searchallresultsbykeyword.md) * [Search locations by keyword.](https://docs.envoapi.com/api/operations/searchlocationsbykeyword.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)