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

List an object's records

A page of records. Four combinations are refused with 400 and cannot be expressed in the parameter list: via requires relatedTo; orderBy cannot be combined with view; cursor requires one of them; and after cannot be combined with either, so page an ordered query with cursor. A cursor positions rows only within the ordering that produced it.

GET/api/v1/objects/{objectId}/records
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
objectIdstringrequired

An object's id

min length 1 · max length 255
Query parameters
afterstring
min length 1 · max length 255
cursorstring
min length 1 · max length 1024
dirstring
default: "desc"
Allowed:ascdesc
limitinteger
min 1 · max 100 · default: 50
orderBystring
matches ^[a-z][a-z0-9_]{0,62}$
relatedTostring
min length 1 · max length 255
viastring
matches ^[a-z][a-z0-9_]{0,62}$
viewstring
min length 1 · max length 2048
Responses
200

A page of records

itemsCrmRecord[]required
Show properties
Array of CrmRecord
archivedAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
createdAtstring<date-time>required
matches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
idstringrequired
min length 1 · max length 255
namestringrequired
objectIdstringrequired
min length 1 · max length 255
revisionintegerrequired
min 1 · max 2147483647
updatedAtstring<date-time>required
matches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
valuesobjectrequired
relationsobjectrequired
nextCursorstring | nullrequired
totalinteger | nullrequired
Show properties
Any of:
integer
integer
null
null
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/objects/string/records' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "items": [
    {
      "archivedAt": "2019-08-24T14:15:22Z",
      "createdAt": "2019-08-24T14:15:22Z",
      "id": "string",
      "name": "string",
      "objectId": "string",
      "revision": 1,
      "updatedAt": "2019-08-24T14:15:22Z",
      "values": {
        "property1": "string",
        "property2": "string"
      },
      "relations": {
        "property1": [
          {
            "archived": true,
            "id": "string",
            "name": "string"
          }
        ],
        "property2": [
          {
            "archived": true,
            "id": "string",
            "name": "string"
          }
        ]
      }
    }
  ],
  "nextCursor": "string",
  "total": -9007199254740991
}

Was this page helpful?