Skip to content
Pitch2SaleDevelopers
Open the app
Early access: these pages are being written and reviewed. Facts in the header boxes come straight from the product.

List custom object types

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

Paginated; archived types are excluded unless include_archived=true. Search labels with q.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
include_archived
string
Allowed values: true false
is_active
string
Allowed values: true false
q
string
<= 200 characters
page
integer
>= 1 <= 10000
limit
integer
>= 1 <= 100

Responses

Section titled “Responses”

200

Section titled “200”

A page of object types

Media typeapplication/json
object
custom_objects
required
Array<object>
object
_id
required
string
api_identifier
required
string
label_singular
required
string
label_plural
required
string
description
required
string | null
fields
required
Array<object>
object
_id
required
string
key
required
string
label
required
string
type
required
string
is_required
required
boolean
key
additional properties
any
is_active
required
boolean
is_archived
required
boolean
created_at
required
string
updated_at
required
string
key
additional properties
any
total
required
number
page
required
number
limit
required
number
Examplegenerated
{
  "custom_objects": [
    {
      "_id": "example",
      "api_identifier": "example",
      "label_singular": "example",
      "label_plural": "example",
      "description": "example",
      "fields": [
        {
          "_id": "example",
          "key": "example",
          "label": "example",
          "type": "example",
          "is_required": true
        }
      ],
      "is_active": true,
      "is_archived": true,
      "created_at": "example",
      "updated_at": "example"
    }
  ],
  "total": 1,
  "page": 1,
  "limit": 1
}

400

Section titled “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
Examplegenerated
{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

401

Section titled “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
Examplegenerated
{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

402

Section titled “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
Examplegenerated
{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

403

Section titled “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
Examplegenerated
{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

429

Section titled “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
Examplegenerated
{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}