List company custom fields

Spree Admin SDK

import { createAdminClient } from '@spree/admin-sdk'

const client = createAdminClient({
  baseUrl: 'https://your-store.com',
  secretKey: 'sk_xxx',
})

const { data: customFields } = await client.customFields('company', 'comp_UkLWZg9DAJ').list()

{
  "data": [
    {
      "id": "cf_UkLWZg9DAJ",
      "label": "Title",
      "field_type": "short_text",
      "key": "custom.title",
      "value": "wool",
      "created_at": "2026-01-15T12:00:00.000Z",
      "updated_at": "2026-01-15T12:00:00.000Z",
      "storefront_visible": true,
      "custom_field_definition_id": "cfdef_UkLWZg9DAJ"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 25,
    "count": 1,
    "pages": 1,
    "from": 1,
    "to": 1,
    "in": 1,
    "previous": null,
    "next": null
  }
}

GET

api

admin

companies

{company_id}

custom_fields

Spree Admin SDK

import { createAdminClient } from '@spree/admin-sdk'

const client = createAdminClient({
  baseUrl: 'https://your-store.com',
  secretKey: 'sk_xxx',
})

const { data: customFields } = await client.customFields('company', 'comp_UkLWZg9DAJ').list()

{
  "data": [
    {
      "id": "cf_UkLWZg9DAJ",
      "label": "Title",
      "field_type": "short_text",
      "key": "custom.title",
      "value": "wool",
      "created_at": "2026-01-15T12:00:00.000Z",
      "updated_at": "2026-01-15T12:00:00.000Z",
      "storefront_visible": true,
      "custom_field_definition_id": "cfdef_UkLWZg9DAJ"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 25,
    "count": 1,
    "pages": 1,
    "from": 1,
    "to": 1,
    "in": 1,
    "previous": null,
    "next": null
  }
}

Filters

Filter with q[<attribute>_<predicate>]=value, for example q[created_at_eq]=…. Send a list as q[<attribute>_in][]=a&q[<attribute>_in][]=b. How filters work.

Attribute	Kind	Predicates
`created_at`	Date and time	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`
`id`	Prefixed ID	`eq` `not_eq` `in` `not_in` `null` `not_null`
`updated_at`	Date and time	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`

Sort by: created_at, id, updated_at. Prefix a field with - to sort descending.

Authorizations

x-spree-api-key

string

header

required

Secret API key for admin access

Authorization

string

header

required

JWT token for admin user authentication

Headers

x-spree-api-key

string

required

Authorization

string

required

Path Parameters

company_id

string

required

Query Parameters

expand

string

Comma-separated associations to expand (e.g., custom_field_definition). Use dot notation for nested expand (max 4 levels).

fields

string

Comma-separated list of fields to include (e.g., key,value,namespace). id is always included.

object

Attribute filters, as q[<attribute>_<predicate>]=value. See Filters above for the list.

Response

200 - application/json

custom fields found

data

object[]

required

Show child attributes

API basics

Endpoints

Filters

Authorizations

Headers

Path Parameters

Query Parameters

Response

​Filters

Authorizations

Headers

Path Parameters

Query Parameters

Response

Filters