Getting Started¶
If you need assistance to kickstart your usage of our API, please don't hesitate to contact us at support@activesteward.com.
Authentication¶
To authenticate requests to the API, you must create an API key and add it every headers of every request
Header | Value |
---|---|
X-API-KEY |
{{API Key}} |
Response Codes¶
Response codes will provide information your request. Where appropriate, error messages will be provided in the response body to give further details of a failed request. For more specific descriptions, use the Reference documentation
Code | Description |
---|---|
200 |
The action ran successfully |
400 |
The supplied data has invalid/missing fields |
403 |
The API key does not have permission to view the requested resource |
404 |
The requested resource was not found |
500 |
An unexpected error occurred. Contact support@activesteward.com |