Skip to main content

Requests & Responses

Base URL

https://www.acmdestiny.net/api/v1

Headers

HeaderValueWhen
Authorizationbearer <token>All authenticated requests.
Content-Typeapplication/jsonRequests with a JSON body.

Request bodies

POST, PUT and PATCH requests send a single-level or nested JSON body:

{
"username": "demo",
"password": "••••••••"
}

The response envelope

Responses are JSON objects built from a consistent set of top-level keys. Not all keys appear on every response — they are included only when relevant.

KeyTypeMeaning
dataobject / arrayThe requested resource(s) or operation result.
noticesarray of stringsInformational messages about a successful operation.
paginationobjectPaging metadata for list endpoints (page, totals, etc.).
warningsarray of stringsNon-field problems with the request.
warn_fieldsarray of objectsField-level validation messages, keyed by field name.
debugarrayDiagnostic detail (development environments).

Successful response

{
"data": {
"message": "pong"
}
}

Successful response with notices

{
"notices": [
"A support email was successfully submitted to us, we will get back to you shortly."
]
}

Pagination

List endpoints return a pagination object alongside the data array. Use it to page through large result sets. Inspect any list endpoint in the API Reference to see the exact pagination fields it returns.

HTTP verbs

VerbUse
GETRead a resource or list.
POSTCreate a resource, or run an action/report.
PUTReplace/update an existing resource.
PATCHPartially update a resource.
DELETERemove a resource.

See Errors for how failures are reported.