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 GET, POST, PATCH, 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 method	Endpoint
POST	Get companies identified
POST	Get visits of companies
POST	Get contacts identified
POST	Get contacts verified

Pagination control

Field	Type	Description
from	number	Use 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 Quote	Description
200	Successfully processed request.
201	Successfully created ressource.

Error Codes

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

HTTP Status Quote	code	message
400	invalid_json	The request body could not be decoded as JSON
	invalid_request_url	This request URL is not valid.
	invalid_request	This request is not supported.
401	unauthorized	The 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.