Skip to main content

Response Format

Important: The API does not use a single universal response envelope. Successful responses are endpoint-specific and may be a JSON string, object, or array. Clients must parse responses according to the schema documented for each endpoint.

Documented responses use application/json.

String Response

"success"

Object Response

{
"status": "success",
"message": ""
}

Array Response

[
".test.ly"
]

Client and SDK Guidance

  • Do not assume every endpoint returns an object.
  • Do not assume a universal status, message, data, or error envelope.
  • Use endpoint-specific response types.
  • Check the endpoint narrative documentation and OpenAPI schema before parsing a response.
  • Do not add a client-side normalization layer unless your application defines and tests it independently of the API contract.

VALIDATION REQUIRED: The public contract does not define a universal error envelope, required response headers, null-versus-omitted behavior, or responses for most non-200 statuses.