Edit this page[Endpoint Name]
// endpoint URL[Description of the endpoint function and usage]
Request Method
[Request method of the endpoint]
Authentication
[Authentication scheme 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]:
RequestResponse
// example API request in cURL// example API response in JSON