Retrieve a custom object type

GET

/api/v1/custom-objects/{id}

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

Authorizations

• bearerJwt
• personalAccessToken
• oauthAccessToken

Parameters

Path Parameters

id

required

string

Responses

200

The object type

Media typeapplication/json

object

custom_object

required

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

Example^generated

{
  "custom_object": {
    "_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"
  }
}

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"
    }
  ]
}