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 encoding (Help:Hash syntax).

Body parameters

When doing a read through a POST request, the parameters must be passed in through the body. Additionally, the body must have the key of "_method" with the value of "get".

URL encoding

These parameters use URL hash encoding (Help:Hash syntax).

• 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 [1].

• Content-Type: application/json
• Format: { "OBJECT": { "PARAMETER": VALUE } }
• Example: { "search": { "name": "test" }, "limit": 20, "_method": "get" }

See also

• Help:API write requests
• Help:API

External links

[1] https://www.w3resource.com/JSON/structures.php

View wiki