Skip to main content

Resources

Single-resource endpoints commonly return the resource under a named field.
Some automation routes return the resource directly when no extra metadata is needed.

Collections

Collection keys describe the returned resource. Count and pagination fields can appear beside the array.

Actions

Start, stop, trigger, resync, and delete endpoints return the accepted state or an empty successful response.

Downloads

Download endpoints return binary content. Read the Content-Type and Content-Disposition response headers instead of parsing JSON.

Errors

Errors use the HTTP status code and a JSON body. Validation and plan-limit responses can include structured details.
Use requestId when contacting Pxxl support.
Examples show stable fields used by clients. Pxxl can add response fields without breaking existing integrations.