Find custom field

Find a custom field definition by its key

GET

/v1/custom-fields/{key}

GET

/custom-fields/{key}

curl -X GET "https://api.corma.io/v1/custom-fields/{key}" \
  -H "x-corma-api-key: $CORMA_OPEN_API_KEY"

Authorization

x-corma-api-key
string
header
required
Colon-separated API key ID and secret: API_KEY_ID:API_KEY_SECRET

Parameters

key
string
path
required

Response

application/json200

OK

key
string
required
label
string
required
type
enum<string>
required
One of:
text
number
boolean
date
user
entity
enum<string>
required
One of:
user
createdAt
string<date-time>
required
The timestamp of when this resource was created. ISO 8601 format.
updatedAt
string<date-time>
required
The timestamp of the last update to this resource. ISO 8601 format.

{
  "key": "string",
  "label": "string",
  "type": "text",
  "entity": "user",
  "createdAt": "2026-01-15T09:30:00Z",
  "updatedAt": "2026-01-15T09:30:00Z"
}

GET

/custom-fields/{key}

curl -X GET "https://api.corma.io/v1/custom-fields/{key}" \
  -H "x-corma-api-key: $CORMA_OPEN_API_KEY"

{
  "key": "string",
  "label": "string",
  "type": "text",
  "entity": "user",
  "createdAt": "2026-01-15T09:30:00Z",
  "updatedAt": "2026-01-15T09:30:00Z"
}

API referenceCustom fields

Find custom field

Find a custom field definition by its key

GET

/v1/custom-fields/{key}

GET

/custom-fields/{key}

curl -X GET "https://api.corma.io/v1/custom-fields/{key}" \
  -H "x-corma-api-key: $CORMA_OPEN_API_KEY"

Authorization

x-corma-api-key
string
header
required
Colon-separated API key ID and secret: API_KEY_ID:API_KEY_SECRET

Parameters

key
string
path
required

Response

application/json200

OK

key
string
required
label
string
required
type
enum<string>
required
One of:
text
number
boolean
date
user
entity
enum<string>
required
One of:
user
createdAt
string<date-time>
required
The timestamp of when this resource was created. ISO 8601 format.
updatedAt
string<date-time>
required
The timestamp of the last update to this resource. ISO 8601 format.

{
  "key": "string",
  "label": "string",
  "type": "text",
  "entity": "user",
  "createdAt": "2026-01-15T09:30:00Z",
  "updatedAt": "2026-01-15T09:30:00Z"
}

GET

/custom-fields/{key}

curl -X GET "https://api.corma.io/v1/custom-fields/{key}" \
  -H "x-corma-api-key: $CORMA_OPEN_API_KEY"

{
  "key": "string",
  "label": "string",
  "type": "text",
  "entity": "user",
  "createdAt": "2026-01-15T09:30:00Z",
  "updatedAt": "2026-01-15T09:30:00Z"
}