The Enlyft API is accessible at https://api.enlyft.com/v2/.
Permission to use the API must be granted to your subscription. API access to the resources is scoped to that subscription and uses credits associated with the subscription.
\nNote: Documentation for v1 API is located here.
\nEach subscription for the Enlyft Application has one or more solutions which are designed to accommodate unique account targeting initiatives or use cases (e.g., account prospecting, marketing campaign). Each solution is identified by a UUID which should be passed to the API to scope the query.
\nPlease see our knowledge base article \"What is a solution\" to understand more about solutions.
\nUse of this API requires authorization in the form of an API key that is included in the HTTP request header. See example below.
\nPlease reach out to us by emailing support@enlyft.com or via the chat button in the Enlyft Application to request an API key.
\nThe number of records of any entity that you can retrieve using the API depends on the number of credits available to your subscription.
\nThe API has a rate limit of 1000 requests per minute.
If you exceed that limit your access will be blocked for the next 60 seconds.
Each API request will include the following rate limit response headers:
\nNote: All time stamps below are in ISO 8601 formatted string.
\n","auth":{"type":"apikey","apikey":{"value":"Job identity (UUID) returned in response to bulk API request (e.g. multiple organizations).
\n","type":"text/plain"},"key":"job_id","value":"<Job identity (UUID) returned in response to bulk API request (e.g. multiple organizations).
\n","type":"text/plain"},"key":"job_id","value":"<Offset used for pagination.
\n","type":"text/plain"},"key":"offset","value":"<Maximum number of items to be returned for this page. Default and maximum is 1000.
\n","type":"text/plain"},"key":"limit","value":"<Note: All time stamps below are in ISO 8601 formatted string.
\nJob identity (UUID) returned in response to bulk API request (e.g. multiple organizations).
\n","type":"text/plain"},"key":"job_id","value":"<The first table below provides the top-level node details in the JSON response. The top-level nodes are always present in the response even if there is no information associated with it in which case the key's value will indicate it with a null / empty array / empty object.
\nThe subkeys of these top-level nodes may be excluded from the response if there is no data available relevant to that node.
\nNote: An asterix (*) next to the key name in these tables indicates that the corresponding object details are explained in another table below.
\nNote: All time stamps below are in ISO 8601 formatted string.
\n","auth":{"type":"apikey","apikey":{"value":"The Enlyft Bulk Jobs API enables you to query entities in bulk instead of single entity per request. The maximum number of entities you can request is limited to 10000. At present only Organization and Person entity are supported with this API.
\nA request for entities in bulk creates a \"bulk job\" whose \"job_id\" is returned in the response. You can use the \"job_id\" to check the job status, collect the results of successful matches or collect the errors related to the bulk job. The job expires in 30 days after which the results will no longer be available. The \"job_status\" provides the expiration date/time. A separate API enables you to list all bulk jobs that were created within your subscription in the last 30 days along with their status.
\nSince the results can be very large the GET Job Results supports pagination via the \"next\" page url returned in the response.
\nThe number of active bulk jobs within your subscription is limited to 5. Submitting additional jobs when this limit is reached results in an error HTTP Status Code 429.
\n","auth":{"type":"apikey","apikey":{"value":"The first table below provides the top-level node details in the JSON response. The top-level nodes are always present in the response even if there is no information associated with it in which case the key's value will indicate it with a null / empty array / empty object.
\nThe subkeys of these top-level nodes may be excluded from the response if there is no data available relevant to that node.
\nNote: An asterix (*) next to the key name in these tables indicates that the corresponding object details are explained in another table below.
\nIdentity (UUID) of the solution within your subscription.
\n","type":"text/plain"},"key":"solution_id","value":"<Optional correlation string that enables you to correlate the response back to your request in case you use Async requests. Please do not provide any information that you do not want to expose as the requests will be logged by Enlyft.
\n","type":"text/plain"},"key":"request_correlation","value":"<The first table below provides the top-level node details in the JSON request body.
\nNote: An asterix (*) next to the key name in these tables indicates that the corresponding object details are explained in another table below.
\nThe first table below provides the top-level node details in the JSON response. The top-level nodes are always present in the response even if there is no information associated with it in which case the key's value will indicate it with a null / empty array / empty object.
\nThe subkeys of these top-level nodes may be excluded from the response if there is no data available relevant to that node.
\nNote: An asterix (*) next to the key name in these tables indicates that the corresponding object details are explained in another table below.
\nThe person is identified by one of the following:
\nperson_id : Identity (UUID) of the requested person
\nperson_email : Work email of the person
\nThe first table below provides the top-level node details in the JSON response. The top-level nodes are always present in the response even if there is no information associated with it in which case the key's value will indicate it with a null / empty array / empty object.
\nThe subkeys of these top-level nodes may be excluded from the response if there is no data available relevant to that node.
\nNote: An asterix (*) next to the key name in these tables indicates that the corresponding object details are explained in another table below.
\nIdentity (UUID) of the solution within your subscription.
\n","type":"text/plain"},"key":"solution_id","value":"<Optional parameter requesting person record only if email is available. Default is 0 - return record even if email is not available.
\n","type":"text/plain"},"key":"require_email","value":"<Optional parameter requesting person record only if phone is available. Default is 0 - return record even if phone is not available.
\n","type":"text/plain"},"key":"require_phone","value":"<Optional parameter requesting email validation before returning response. Default is 0 - no validation.\nSetting this to \"1\" can slow the response, but provides additional validation.
\n","type":"text/plain"},"key":"validate_email","value":"<[Coming Soon] Optional parameter requesting phone validation before returning response. Default is 0 - no validation.\nSetting this to \"1\" can slow the response, but provides additional validation.
\n","type":"text/plain"},"key":"validate_phone","value":"<Optional correlation string that enables you to correlate the response back to your request in case you use Async requests.\nNote: Please do not provide any information that you do not want to expose as the requests will be logged by Enlyft.
\n","type":"text/plain"},"key":"request_correlation","value":"<The first table below provides the top-level node details in the JSON request body.
\nNote: An asterix (*) next to the key name in these tables indicates that the corresponding object details are explained in another table below.
\nThe first table below provides the top-level node details in the JSON response. The top-level nodes are always present in the response even if there is no information associated with it in which case the key's value will indicate it with a null / empty array / empty object.
\nThe subkeys of these top-level nodes may be excluded from the response if there is no data available relevant to that node.
\nNote: An asterix (*) next to the key name in these tables indicates that the corresponding object details are explained in another table below.
\nUse Discover Person API to search for persons in Enlyft Database. Use several person and organization filters to narrow-down your search. E.g. Find IT Managers with <1 year of experience in current role, in organization with revenue of 10-50M, located in United States.
\nCredits are consumed at 1 credit/person for results through this API. Credits are only charges for net-new persons, which are not previously saved or accessed through enlyft app, CRM or API.
\nThis endpoint has a limit of 10,000 results per api call. You can access more results in batches.
\nThe first table below provides the top-level node details in the JSON request body.
\nNote: An asterix (*) next to the key name in these tables indicates that the corresponding object details are explained in another table below.
\nThis API responds with a Job ID and you can use our Job APIs (Status/Results/Errors) to access the results of the search.
\nThe first table below provides the top-level node details in the JSON response. The top-level nodes are always present in the response even if there is no information associated with it in which case the key's value will indicate it with a null / empty array / empty object.
\nThe subkeys of these top-level nodes may be excluded from the response if there is no data available relevant to that node.
\nNote: An asterix (*) next to the key name in these tables indicates that the corresponding object details are explained in another table below.
\nThe first table below provides the top-level node details in the JSON response. The top-level nodes are always present in the response even if there is no information associated with it in which case the key's value will indicate it with a null / empty array / empty object.
\nThe subkeys of these top-level nodes may be excluded from the response if there is no data available relevant to that node.
\nNote: An asterix (*) next to the key name in these tables indicates that the corresponding object details are explained in another table below.
\nThis API does not consume additional credits. It provides extended information on organizations that have already been accessed through the 'Organization' API. If called for an organization that has not been previously accessed, it will return HTTP status code '422'.
\nThe first table below provides the top-level node details in the JSON response. The top-level nodes are always present in the response even if there is no information associated with it in which case the key's value will indicate it with a null / empty array / empty object.
\nThe subkeys of these top-level nodes may be excluded from the response if there is no data available relevant to that node.
\nNote: An asterix (*) next to the key name in these tables indicates that the corresponding object details are explained in another table below.
\nIdentity (UUID) of the solution within your subscription.
\n","type":"text/plain"},"key":"solution_id","value":"<Identity (UUID) or domain of the organization.
\n","type":"text/plain"},"key":"org","value":"<Optional correlation string that enables you to correlate the response back to your request in case you use Async requests. Please do not provide any information that you do not want to expose as the requests will be logged by Enlyft.
\n","type":"text/plain"},"key":"request_correlation","value":"<This API does not consume additional credits. It provides extended information on organizations that have already been accessed through the 'Organization' API. If called for an organization that has not been previously accessed, it will return HTTP status code '422'.
\nThe first table below provides the top-level node details in the JSON response. The top-level nodes are always present in the response even if there is no information associated with it in which case the key's value will indicate it with a null / empty array / empty object.
\nThe subkeys of these top-level nodes may be excluded from the response if there is no data available relevant to that node.
\nNote: An asterix (*) next to the key name in these tables indicates that the corresponding object details are explained in another table below.
\nNote: The fields in event object varies with the event type and sub-type.
\nIdentity (UUID) of the solution within your subscription.
\n","type":"text/plain"},"key":"solution_id","value":"<Identity (UUID) or domain of the organization.
\n","type":"text/plain"},"key":"org","value":"<Optional correlation string that enables you to correlate the response back to your request in case you use Async requests. Please do not provide any information that you do not want to expose as the requests will be logged by Enlyft.
\n","type":"text/plain"},"key":"request_correlation","value":"<