Get Office API
The Get Office API helps you retrieve the most up-to-date information on an already-identified office.
Just by using Neuron360 office identification (office_id).
You must have an active API key and a valid subscription to use the Get Office API. If we have a Neuron360 user account, you can log in to the Neuron360 Portal. You can copy your API key from the account section. If you don't have one, no worries; book an appointment with one of our Neuron360 sale representatives to start with a trial.
Endpoint
GET api.neuron360.io/office/INSERT YOUR OFFICE ID HERE
Billing
All office returns will be charged as one 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 office data returned ordered. The content will depend on the reveal_all_data value of the query parameters. |
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 | up to 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 10 months ago