REST API (deprecated)
Overview
Our REST API is deprecated and is replaced by our GraphQL API
Base URL
All URLs referenced in the documentation have the following base:
https://sd.iadvize.com/api/2
https://ha.iadvize.com/api/2
The iAdvize REST API is served over HTTPS.
Authentication
The API key must be attached to each request. You can use it in one of the following ways:
Passed in as a
X-API-Key
HTTP headerPassed in as a
key
GET parameterPassed in as the username (with an arbitrary password) via
HTTP Basic authentication
Calls, errors & responses
Authentication failed
Read
GET /my_resource
Common filters
page
Page number
?page=1
limit
Maximum number of resources per page (maximum possible value is 100)
?limit=1
full
Show all fields of the resource
?full=1
Use the *
character to broaden the scope of your search. E.g.: filters[name]=*uli*
GET /my_resource/123
GET /my_resource/456
(with error)
Last updated
Was this helpful?