---
title: "List all customers"
method: GET
path: "/v2/customers"
tags: ["Customers"]
---

# List all customers

`GET /v2/customers`

## Request

- Base URL: `https://api.partnerstack.com/api`
- URL: `https://api.partnerstack.com/api/v2/customers`
- Auth: HTTP bearer

Returns a list of your customers. The customers are returned sorted by creation date by default, with the most recent customers appearing first.

## Query parameters

- `partnership_key` string
- `min_created` integer
- `max_created` integer
- `order_by` '-created_at' | 'created_at'
- `limit` integer
- `starting_after` string
- `ending_before` string

## Response `200`

Returns a list of your customers. The customers are returned sorted by creation date by default, with the most recent customers appearing first.

- object
  - `data` object, required
    - `has_more` boolean
    - `items` object[]
      - `created_at` integer: Immutable Unix timestamp in milliseconds taken at time of creation
      - `key` string: Unique key of this customer
      - `updated_at` integer: Unix timestamp in milliseconds taken at time of last update
      - `archived` boolean: The boolean flag which determines if the customer is archived or not
      - `company` object: Base schema representation of a company
        - `key` string: Unique key of this company
        - `name` string: The name of this company
      - `country_iso` string, nullable: The abbreviated name of the customer's country of origin
      - `customer_key` string, nullable: The key provided by the company to identify the customer
      - `fields` object[], nullable: An array of objects representing the Customer's fields and their values. Fields hidden from partners are omitted.
        - `api_name` string: API name of this field to be used on create / update / serialization. Created at time of field creation but can be edited
        - `description` string, nullable: Description of the field to be displayed to the partner
        - `help_text` string, nullable: The help text that is provided for this field
        - `name` string: Name of field that is presented
        - `options` object: Options to select from if this field is a picklist/checkbox
        - `position` integer: The position that this field will be displayed in relation to others on the same form (index starts at 0)
        - `read_only` boolean: Whether or not this field is read only
        - `required` boolean: Whether or not this field will be required when filling out its attached form
        - `type` string: The type of field that will be presented (input, picklist, number ect.)
        - `value` unknown
      - `has_paid` boolean: The boolean flag which determines if the customer has paid or not
      - `meta` object, nullable: The Customer's field values keyed by the field's api_name. Fields hidden from partners are omitted.
      - `partnership_key` string: Unique key of this partnership
      - `shared_id` string, nullable: The shared id of the customer
      - `sub_ids` string[]
    - `total` integer, nullable
  - `message` string, required
  - `status` integer, required

## Other responses

- `400`: Bad Request Error
- `401`: Unauthorized Error
- `403`: Forbidden Error
- `404`: Not Found Error
- `500`: Internal Server Error

---

[API](https://skmtc.dev/partnerstack/apis/partnerstack-partner-api.md) - [All operations](https://skmtc.dev/partnerstack/apis/partnerstack-partner-api/llms.txt) - [OpenAPI document](https://skmtc.dev/partnerstack/apis/partnerstack-partner-api/revisions/c050e16b8752?raw)