Office Search API
The Office Search API is designed to let you identify a subset of offices that will fulfill your needs.
We have made available various parameters that will allow you to be very specific or more generic to help your organization target a market.
You must have an active API key and a valid subscription to use the Office Search API. If we have a Neuron360 user account, you can log in to the Neuron360 Portal to retrieve it. If you don't have one, no worries; book an appointment with one of our Neuron360 sale representatives to start with a trial.
Endpoint
POST api.neuron360.io/office/search
Billing
When the request setting "reveal_all_data" is activated, each company returned will be charged as 1 corpo record credit against your credit balance.
Response
On success (200)
Response Field | Description |
---|---|
query | The query parameters of the request. |
counts | The total number of records (*) that match the request query. |
results | The company data returned ordered. The content will depend on the reveal_all_data value of the query parameters. |
pagination | The pagination values, which you can use for further pagination. |
transaction_detail | All information related to the transaction. |
(*) All counts provided are an approximation of the number of records.
On error (4XX)
Response Field | Description |
---|---|
query | The query parameters of the request. |
errors | The list of errors encountered for this request. |
transaction_detail | All information related to the transaction. |
Rate Limit
Neuron360 API applies rate limits based on the product used. The rate limits are associated with your account API key.
endpoint | |
---|---|
office/search | 1,500 requests per minute per account / API Key (*) |
(*) If you send requests at a higher pace, the API will send an error of too many requests (429).
Updated 11 months ago