The reference is your key to a comprehensive understanding of the GetQuanty API

Conventions

The base URL to send all API requests is https://api.getquanty.com. HTTPS is required for all API requests.

The GetQuanty API follows RESTful conventions when possible, with most operations performed via GETPOSTPATCH, and DELETE requests on database resources. Request and response bodies are encoded as JSON.

Code samples

Samples requests and responses are shown for each endpoint. These samples make it easy to copy, paste, and modify as you build your integration.

You may choose any language or library that allows you to make HTTP requests.

Pagination

Endpoints that return lists of objects support cursor-based pagination requests. By default, the API returns 500 items per API call. If the number of items in a response from a support endpoint exceeds the default, then an integration can use pagination to iterate over each 500 results using a specific body field.

Supported endpoints

HTTP methodEndpoint
POSTGet companies identified
POSTGet visits of companies
POSTGet contacts identified
POSTGet contacts verified

Pagination control

FieldTypeDescription
fromnumberUse this field in your requests to get results next 500 results after the value specified.

Status Codes

HTTP response code are used to indicate general classes of success and error.

Success Codes

HTTP Status QuoteDescription
200Successfully processed request.
201Successfully created ressource.

Error Codes

Error responses contain more detail about the error in the response body, in the code and messageproperties.

HTTP Status Quotecodemessage
400invalid_jsonThe request body could not be decoded as JSON
invalid_request_urlThis request URL is not valid.
invalid_requestThis request is not supported.
401unauthorizedThe bearer token is not valid.

Versionning

Our latest API version is v1. You set the version by including a prefix to the base API route with the version you need. Setting the version prefix is required. For exemple for our latest version you will have : https://api.getquanty.com/v1.