REST API (partially deprecated)
Overview
Last updated
Overview
Last updated
Our REST API is partially deprecated and is aimed to be fully replaced by our GraphQL API
All URLs referenced in the documentation have the following base:
Standard platform | High availability platform |
---|---|
The iAdvize REST API is served over HTTPS.
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 header
Passed in as a key
GET parameter
Passed in as the username (with an arbitrary password) via HTTP Basic authentication
GET /my_resource
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)
Filter | Description | Values |
---|---|---|
https://sd.iadvize.com/api/2
https://ha.iadvize.com/api/2
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