List custom fields

List all custom field definitions in the company workspace

GET

/v1/custom-fields

GET

/custom-fields

curl -X GET "https://api.corma.io/v1/custom-fields" \
  -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

take
integer
query
Default:
50
skip
integer
query
Default:
0

Response

application/json200

OK

pagination
PaginationResponseMeta
required
items
CustomField[]
required

{
  "pagination": {
    "take": 0,
    "skip": 0,
    "total": 0
  },
  "items": [
    {
      "key": "string",
      "label": "string",
      "type": "text",
      "entity": "user",
      "createdAt": "2026-01-15T09:30:00Z",
      "updatedAt": "2026-01-15T09:30:00Z"
    }
  ]
}

GET

/custom-fields

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

{
  "pagination": {
    "take": 0,
    "skip": 0,
    "total": 0
  },
  "items": [
    {
      "key": "string",
      "label": "string",
      "type": "text",
      "entity": "user",
      "createdAt": "2026-01-15T09:30:00Z",
      "updatedAt": "2026-01-15T09:30:00Z"
    }
  ]
}

API referenceCustom fields

List custom fields

List all custom field definitions in the company workspace

GET

/v1/custom-fields

GET

/custom-fields

curl -X GET "https://api.corma.io/v1/custom-fields" \
  -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

take
integer
query
Default:
50
skip
integer
query
Default:
0

Response

application/json200

OK

pagination
PaginationResponseMeta
required
items
CustomField[]
required

{
  "pagination": {
    "take": 0,
    "skip": 0,
    "total": 0
  },
  "items": [
    {
      "key": "string",
      "label": "string",
      "type": "text",
      "entity": "user",
      "createdAt": "2026-01-15T09:30:00Z",
      "updatedAt": "2026-01-15T09:30:00Z"
    }
  ]
}

GET

/custom-fields

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

{
  "pagination": {
    "take": 0,
    "skip": 0,
    "total": 0
  },
  "items": [
    {
      "key": "string",
      "label": "string",
      "type": "text",
      "entity": "user",
      "createdAt": "2026-01-15T09:30:00Z",
      "updatedAt": "2026-01-15T09:30:00Z"
    }
  ]
}