Get a list of custom fields

GET /custom_fields

Api key auth

Query parameters

page integer(int32)

Page Number
limit integer(int32)

Number of items per page
entity_type string

Filter custom fields by entity type

Values are item or order.

Responses

200 application/json

OK
Hide response attributes Show response attributes object
- pagination object
  
  Hide pagination attributes Show pagination attributes object
  
  current integer(int32)
  
  previous integer(int32)
  
  next integer(int32)
  
  limit integer(int32)
  
  total_pages integer(int32)
  
  total_count integer(int32)
- data array[object]
  
  Hide data attributes Show data attributes object
  
  id string(guid)
  
  System generated unique identifier. Don't include this in POST request body.
  
  key string
  
  label string
  
  entity_type string
  
  Values are item or order.
  
  value_type string
  
  Values are string, number, boolean, or array.
  
  options array[string]
  
  created_at string(date-time)
  
  updated_at string(date-time)

GET /custom_fields

curl \
 --request GET 'https://app.getfoundation.com/api/external/v1/custom_fields' \
 --header "X-API-Key: $API_KEY"

Response examples (200)

{
  "pagination": {
    "current": 42,
    "previous": 42,
    "next": 42,
    "limit": 42,
    "total_pages": 42,
    "total_count": 42
  },
  "data": [
    {
      "id": "9aa62446-c3b0-42f5-8027-3648daed9d73",
      "key": "country_of_origin",
      "label": "Country Of Origin",
      "entity_type": "item",
      "value_type": "string",
      "options": [
        "USA",
        "China",
        "India"
      ],
      "created_at": "2025-05-04T09:42:00Z",
      "updated_at": "2025-05-04T09:42:00Z"
    }
  ]
}