Requests & Responses
Base URL
https://www.acmdestiny.net/api/v1
Headers
| Header | Value | When |
|---|---|---|
Authorization | bearer <token> | All authenticated requests. |
Content-Type | application/json | Requests 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.
| Key | Type | Meaning |
|---|---|---|
data | object / array | The requested resource(s) or operation result. |
notices | array of strings | Informational messages about a successful operation. |
pagination | object | Paging metadata for list endpoints (page, totals, etc.). |
warnings | array of strings | Non-field problems with the request. |
warn_fields | array of objects | Field-level validation messages, keyed by field name. |
debug | array | Diagnostic 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
| Verb | Use |
|---|---|
GET | Read a resource or list. |
POST | Create a resource, or run an action/report. |
PUT | Replace/update an existing resource. |
PATCH | Partially update a resource. |
DELETE | Remove a resource. |
See Errors for how failures are reported.