API Common Guide
Last updated
Last updated
GitBook tip: A succinct video overview is a great way to introduce folks to your product. Embed a Loom, Vimeo or YouTube video and you're good to go! We love this video from the fine folks at Loom as a perfect example of a succinct feature overview.
API Request Methods
API only accept /???application/json???/ for calls, and parameter passing is done in the following manner.
Method | Type | Description |
---|---|---|
Common status codes
Response status codes indicate the execution result of an API call. We only respond to the status codes below, and any response status codes that are not represented are represented in the _code field of the Response Body.
Status Code | Description |
---|---|
GET
URL
Query parameters as represented in the request URL
POST
BODY
Data represented as application/json in the request body
200
Successful API execution
400
4xx errors
500
5xx errors