Skip to content
Taylorz CRM Developers
Esc
↑↓navigate↵open⌘Jpreview

Run a saved report

Runs the saved definition as it stands now.

GET/api/v1/reports/{id}/results
Authorization
AuthorizationOAuth2 access token · headerrequired

Authorization-code grant with PKCE. Clients are public and hold no secret. Discovery is published at /.well-known/oauth-authorization-server/api/auth.

Scopes:api.access
Path parameters
idstringrequired

A saved report's id

min length 1 · max length 255
Responses
200

The rows the saved report produces

Array of ReportResultRow
labelstring | nullrequired
valuestring | nullrequired
400

The request body, query or parameters were refused

codestringrequired
Allowed:invalid_inputnot_foundconflictforbidden
detailany
errorstringrequired
reasonstring
401

The access token is missing, invalid or revoked

errorstringrequired
403

The tenant's module is off, or the token's scope or the member's role does not permit the action

codestringrequired
Allowed:invalid_inputnot_foundconflictforbidden
detailany
errorstringrequired
reasonstring
404

No such record, or none the caller may read

codestringrequired
Allowed:invalid_inputnot_foundconflictforbidden
detailany
errorstringrequired
reasonstring
413

The request exceeds the route's body limit

errorstringrequired
500

An unexpected failure

errorstringrequired
Request
curl -X GET '/api/v1/api/v1/reports/string/results' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Accept: application/json'
Response
[
  {
    "label": "string",
    "value": "string"
  }
]

Was this page helpful?