List records of a custom object

GET

/api/v1/custom-objects/{objectId}/records

curl --request GET \
  --url 'https://api.pitch2sale.com/api/v1/custom-objects/example/records?include_archived=true' \
  --header 'Authorization: Bearer <token>'

Paginated; narrow with owner_id, filter, sort and q. Limited to the records the caller may view, and fields the caller’s role may not read are masked.

Authorizations

• bearerJwt
• personalAccessToken
• oauthAccessToken

Parameters

Path Parameters

objectId

required

string

Query Parameters

include_archived

string

Allowed values: true false

owner_id

string

/^[0-9a-fA-F]{24}$/

filter

string

<= 4000 characters

sort

string

<= 1000 characters

q

string

>= 1 characters <= 200 characters

page

integer

>= 1 <= 10000

limit

integer

>= 1 <= 100

Responses

200

A page of records

Media typeapplication/json

object

records

required

Array<object>

object

_id

required

string

object_definition_id

required

string

owner_id

required

string | null

key

additional properties

any

total

required

number

page

required

number

limit

required

number

Example^generated

{
  "records": [
    {
      "_id": "example",
      "object_definition_id": "example",
      "owner_id": "example"
    }
  ],
  "total": 1,
  "page": 1,
  "limit": 1
}

400

Validation failed

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

401

Authentication required or token invalid

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

402

Feature not available on the organization plan

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

403

Role permission or token scope missing

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

429

Rate limit exceeded

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}