List custom fields

GET 
/api/v3/_customfield

Possible values for type:

• string - a single-line free-form text field
• select - a dropdown/select box offering a specific set of choices
• date - a date
• number - a number

If the type is select, available choices will be returned in type_opts.

The field attribute is the API field name you can use to populate custom field data onto an object. For example, if context_str=customer and field=custom_2 then when you create a customer via the REST API, you would send:

POST /api/v3/customer

{ "company": "Sombra Corporation", "custom_2": "The Dark Tower" }

Custom fields are not required, so can be left out of API requests if you do not wish to provide a value.

Request

Responses

200

Object was fetched successfully

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable

response

object[]

Array [

customfield_id integer

Custom field ID #

name string

Name

type string

Type

type_opts array

Type options (e.g. allowable dropdown values)

enabled boolean

Enabled/disabled

context_str string

Context

field string

API field name

]

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": [
    {
      "customfield_id": 0,
      "name": "string",
      "type": "string",
      "type_opts": [
        null
      ],
      "enabled": true,
      "context_str": "string",
      "field": "string"
    }
  ]
}

Example 1

{
  "code": 200,
  "status": "OK",
  "message": "",
  "details": {},
  "response": [
    {
      "context_str": "customer",
      "field": "custom_2",
      "customfield_id": 417,
      "name": "Favorite Book",
      "enabled": true,
      "type": "select",
      "type_opts": [
        "Snow Crash",
        "Perdido Street Station",
        "The Dark Tower",
        "Other"
      ]
    },
    {
      "context_str": "quote",
      "field": "custom_1",
      "customfield_id": 418,
      "name": "Favorite Color",
      "enabled": true,
      "type": "string",
      "type_opts": null
    }
  ]
}

400

Bad request

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response boolean

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": true
}

Example 1

{
  "code": 400,
  "status": "Error",
  "message": "Missing or invalid parameter.",
  "details": {},
  "response": false
}

401

Authentication error

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response boolean

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": true
}

Example 1

{
  "code": 401,
  "status": "Error",
  "message": "Invalid or incorrect authorization [Missing (basic) authorization header.]",
  "details": {},
  "response": false
}

404

Object not found

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response booleannullable

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": true
}

Example 1

{
  "code": 404,
  "status": "Error",
  "message": "This object does not exist.",
  "details": {},
  "response": null
}

Loading...