> ## Documentation Index
> Fetch the complete documentation index at: https://developers.redo.com/llms.txt
> Use this file to discover all available pages before exploring further.

# customerCustomFieldDeclarations

> List customer custom field declarations in this store's catalog, optionally filtered by name or data type.

**Required scopes:** [`customers_read`](https://developers.redo.com/docs/api-reference/v3/reference/scopes#scope-customers_read)

**Store must have one of:** `EMAIL_SMS`

## Arguments

**after** `String`

Forward pagination cursor — returns declarations after it.

**before** `String`

Backward pagination cursor — returns declarations before it.

**dataType** `[CustomerCustomFieldDataType](/docs/api-reference/v3/reference/marketing/customer-custom-field-data-type)`

Only include declarations with this data type.

**first** `Int`

Forward pagination: returns the first N declarations (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.

**last** `Int`

Backward pagination: returns the last N declarations (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.

**orderBy** `[CustomerCustomFieldDeclarationSortKey](/docs/api-reference/v3/reference/marketing/customer-custom-field-declaration-sort-key)`

Which key to sort by (defaults to name, A–Z). Combine with `reverse` to flip direction.

**query** `String`

Case-insensitive substring match on the field name. At most 200 characters.

**reverse** `Boolean`

Reverses the sort direction selected by `orderBy` (or its default).

## Returns

**customerCustomFieldDeclarations** `[CustomerCustomFieldDeclarationConnection!](/docs/api-reference/v3/pagination)` *required*

A paginated list of CustomerCustomFieldDeclaration items.

**fields**

**edges** `[\[CustomerCustomFieldDeclarationEdge!\]!](/docs/api-reference/v3/pagination)` *required*

The list of edges (each a node plus its pagination `cursor`).

**fields**

**cursor** `String!` *required*

Opaque cursor for this item; pass to `after`/`before` to page from here.

**node** `[CustomerCustomFieldDeclaration!](/docs/api-reference/v3/reference/marketing/customer-custom-field-declaration)` *required*

The item at this edge.

**fields**

**createdAt** `[DateTime](/docs/api-reference/v3/reference/common/date-time)`

When this custom field declaration was created.

**dataType** `[CustomerCustomFieldDataType!](/docs/api-reference/v3/reference/marketing/customer-custom-field-data-type)` *required*

The value type of the custom field.

**id** `ID!` *required*

The id of this custom field declaration.

**isMultiValued** `Boolean!` *required*

Whether a customer can hold multiple values for this field.

**legacyId** `String`

The declaration's legacy Mongo ObjectId (24-char hex) from before the CockroachDB migration.

**name** `String!` *required*

The merchant-facing name of the custom field.

**options** `[String!]!` *required*

Allowed picklist values when defined, encoded as strings. Empty when unrestricted.

**updatedAt** `[DateTime](/docs/api-reference/v3/reference/common/date-time)`

When this custom field declaration was last updated.

**nodes** `[\[CustomerCustomFieldDeclaration!\]!](/docs/api-reference/v3/reference/marketing/customer-custom-field-declaration)` *required*

The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.

**fields**

**createdAt** `[DateTime](/docs/api-reference/v3/reference/common/date-time)`

When this custom field declaration was created.

**dataType** `[CustomerCustomFieldDataType!](/docs/api-reference/v3/reference/marketing/customer-custom-field-data-type)` *required*

The value type of the custom field.

**id** `ID!` *required*

The id of this custom field declaration.

**isMultiValued** `Boolean!` *required*

Whether a customer can hold multiple values for this field.

**legacyId** `String`

The declaration's legacy Mongo ObjectId (24-char hex) from before the CockroachDB migration.

**name** `String!` *required*

The merchant-facing name of the custom field.

**options** `[String!]!` *required*

Allowed picklist values when defined, encoded as strings. Empty when unrestricted.

**updatedAt** `[DateTime](/docs/api-reference/v3/reference/common/date-time)`

When this custom field declaration was last updated.

**pageInfo** `[PageInfo!](/docs/api-reference/v3/pagination)` *required*

Pagination metadata for the current page.

**fields**

**endCursor** `String`

Cursor of the last edge in this page; pass to `after` to page forward.

**hasNextPage** `Boolean!` *required*

Whether more items exist after this page (drives forward pagination with `first`/`after`).

**hasPreviousPage** `Boolean!` *required*

Whether more items exist before this page (drives backward pagination with `last`/`before`).

**startCursor** `String`

Cursor of the first edge in this page; pass to `before` to page backward.

## Example

```graphql theme={null}
query {
  customerCustomFieldDeclarations(after: "...", before: "...", dataType: BOOLEAN, first: 10, last: 10, orderBy: NAME, query: "...", reverse: true) {
    nodes {
      createdAt
      dataType
      id
      isMultiValued
      legacyId
      name
      options
      updatedAt
    }
    pageInfo { hasNextPage endCursor }
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.