List custom fields

GET

/api/v1/custom-fields

curl --request GET \
  --url 'https://api.pitch2sale.com/api/v1/custom-fields?entity_type=lead' \
  --header 'Authorization: Bearer <token>'

Every custom field defined on leads, contacts, opportunities and activities; filter with entity_type. Not paginated.

Authorizations

• bearerJwt
• personalAccessToken
• oauthAccessToken

Parameters

Query Parameters

entity_type

string

Allowed values: lead contact opportunity activity

Responses

200

The custom fields

Media typeapplication/json

object

custom_fields

required

Array<object>

object

_id

required

string

entity_type

required

string

Allowed values: lead contact opportunity activity

label

required

string

field_key

required

string

type

required

string

choices

required

Array<string>

is_required

required

boolean

is_shared

required

boolean

order

required

number

key

additional properties

any

Example

{
  "custom_fields": [
    {
      "entity_type": "lead"
    }
  ]
}

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

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