List Records
Records can be listed and filtered via search(). It takes a mandatory domain filter (possibly empty) and returns the database identifiers of all records matching the filter.
GET /restapi/1.0/object/{object_name}
Request:
JSON Response:
XML Response:
Query Parameters:
domain – A search domain. Use an empty list to match all records.
offset – OPTIONAL. Number of results to ignore (default: none)
limit – OPTIONAL. Maximum number of records to return (default: all)
order – OPTIONAL. Sort string
count – OPTIONAL. if True, only counts and returns the number of matching records (default: False)
Request Headers
Accept – the response content type depends on Accept header
Authorization – The OAuth protocol parameters to authenticate.
Response Headers
Content-Type – this depends on Accept header of the request
Status Codes
200 OK – no error
404 Not Found – there’s no resource
401 Unauthorized – authentication failed
403 Forbidden – if any error raise
Last updated