Edit this page

[Endpoint Name]

Copy
Copied
// endpoint URL

[Description of the endpoint function and usage]

Request Method

[Request method of the endpoint]

URL Params

Name Type Mandatory Description
[Parameter name] [Data type, like STRING, NUMBER, BOOLEAN ] [YES OR NO] [Description of the parameter]

Query Params

Name Type Mandatory Description
[Parameter name] [Data type, like STRING, NUMBER, BOOLEAN ] [YES OR NO] [Description of the parameter]

Returns

[A bulleted list of the fields, data types, and description of the endpoint response]

Example

Here is an example request to [do something with endpoint]:

Request

Copy
Copied
// example API request in cURL

Response

Copy
Copied
// example API response in JSON