help:api read requests
These are API requests which use the HTTP GET or POST methods.
Limit
Read requests are unlimited for all user levels.
URL parameters
When doing a read through a GET request, the parameters must be passed in through the URL, and must use URL hash format (Help:Hash format).
Body parameters
When doing a read through a POST request, the parameters must be passed in through the body. See the method override below for more information [1].
URL encoding
These parameters use URL hash encoding (Help:Hash format).
- Content-Type:
application/x-www-form-urlencoded - Format: PARAMETER=VALUE
- Example:
search[name]=test&limit=20_method=get
JSON encoding
These parameters use JSON hash encoding [2].
- Content-Type:
application/json - Format: { "OBJECT": { "PARAMETER": VALUE } }
- Example:
{ "search": { "name": "test" }, "limit": 20}
Using POST for GET override
The POST method can be used to send data to endpoints that require the GET method, in such cases where the parameters must be sent in the body, such as the URL limit being exceeded.
URL encoding
Set the parameter _method with the value "get".
JSON encoding
Set the X-HTTP-Method-Override header with value "get".