> For the complete documentation index, see [llms.txt](https://docs.pyck.cloud/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.pyck.cloud/graphql-api/queries/customers.md).

# Customers

Customers Query

Returns a paginated list of Customer objects, with optional filtering and ordering.

## Arguments

| Name      | Type                 | Description                                                            |
| --------- | -------------------- | ---------------------------------------------------------------------- |
| `after`   | `Cursor`             | Returns the elements in the list that come after the specified cursor  |
| `first`   | `Int`                | Returns the first *n* elements from the list                           |
| `before`  | `Cursor`             | Returns the elements in the list that come before the specified cursor |
| `last`    | `Int`                | Returns the last *n* elements from the list                            |
| `orderBy` | `CustomerOrder`      | Ordering options for customers returned from the connection            |
| `where`   | `CustomerWhereInput` | Filtering options for customers returned from the connection           |

## Return Type

`CustomerConnection!` - A connection to a list of Customer objects with pagination information.

## Notes

* The `data` field contains custom attributes as JSON
* Use `Data`, `DataHasKey`, `DataIn`, and `DataContains` filters for querying JSON data
* See [Advanced JSON Field Queries](https://github.com/pyck-ai/docs/blob/main/graphql/advanced/json-field-queries.md) for detailed JSON query examples

## Usage Example

```graphql
query {
  # Search customers by name
  customers(
    where: {
      name_CONTAINS: "Corp"
    },
    orderBy: { direction: ASC, field: NAME }
  ) {
    edges {
      node {
        id
        name
        code
        email
        data
      }
      cursor
    }
    totalCount
  }
}
```

```graphql
query {
  # Get customers with recent orders
  customers(
    where: {
      pickingOrders_SOME: {
        createdAt_GTE: "2024-01-01T00:00:00Z"
      }
    },
    first: 20
  ) {
    edges {
      node {
        id
        name
        pickingOrders {
          id
          createdAt
          orderitems {
            quantity
            item {
              sku
            }
          }
        }
      }
    }
  }
}
```

## Common Filters

* `name_CONTAINS` - Search by customer name
* `code` - Find by exact customer code
* `email` - Find by email address
* `dataTypeSlug` - Filter by customer type
* `pickingOrders_SOME` - Filter by order criteria

## Notes

* Customers are linked to picking orders
* Support custom fields through data/dataType
* Can represent both individuals and organizations
* Use virtual repositories named after customers for shipping


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.pyck.cloud/graphql-api/queries/customers.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.