# List all customers

Endpoint: GET /organizations/{organizationId}/customers
Version: 1.0.33
Security: bearerAuth

## Path parameters:

  - `organizationId` (string, required)
    Organization ID of the member accessing the resource

## Query parameters:

  - `offset` (integer)

  - `limit` (integer)

  - `scope` (string)
    All will return all visible customers. Team will restrict this to those where your team members (members under a shared manager) are assigned a role on the customer. Mine will only return customers you are assigned a role to on the customer.

  - `status` (string)

  - `updatedSince` (string)
    Only return customers updated at or after this time, up to now.

  - `memberId` (integer)
    Only return customers this member is assigned to (in any role).

  - `memberRoleId` (integer)
    Narrow the `memberId` filter to a single role, e.g. CSM. The role id is the `id` returned by ListMemberRoles. Must be supplied together with `memberId`.

  - `sourceKey` (string)
    The source to match `sourceExternalId` against, e.g. salesforce. This is the `key` returned in a customer `sources` entry. Must be supplied together with `sourceExternalId`.

  - `sourceExternalId` (array)
    Filter customers by their ID in an external source, such as a CRM. Must be supplied together with `sourceKey`.

  - `segment` (array)
    Filter customers by segment name

  - `domain` (array)
    Filter customers by domain, e.g. example.com

  - `country` (array)
    Filter customers by country

  - `region` (array)
    Filter customers by region

  - `city` (array)
    Filter customers by city

## Response 200 fields (application/json):

  - `items` (array, required)

  - `items.id` (integer, required)
    Example: 1234

  - `items.name` (string, required)
    Example: Acme Corp

  - `items.city` (string, required)
    Example: San Francisco

  - `items.country` (string, required)
    Example: US

  - `items.region` (string, required)
    Example: US

  - `items.timezone` (string, required)
    Example: America/Los_Angeles

  - `items.domain` (string, required)
    Example: acme.com

  - `items.employeeCount` (integer, required)
    Example: 500

  - `items.segment` (string, required)
    Example: Enterprise

  - `items.memberRoles` (array, required)

  - `items.memberRoles.members` (array, required)

  - `items.memberRoles.members.id` (integer, required)
    Example: 1234

  - `items.memberRoles.members.firstName` (string, required)
    Example: Phoebe

  - `items.memberRoles.members.lastName` (string, required)
    Example: Frere

  - `items.memberRoles.members.email` (string, required)
    Example: phoebe@example.com

  - `items.memberRoles.members.organizationId` (string, required)
    Example: my-organization-id

  - `items.memberRoles.members.managerId` (integer, required)
    The Member ID of this member's manager

  - `items.memberRoles.key` (string, required)
    Example: csm

  - `items.memberRoles.name` (string, required)
    Example: CSM

  - `items.customFields` (array, required)

  - `items.customFields.key` (string, required)
    Example: health_score

  - `items.customFields.value` (any, required)
    Example: 85

  - `items.products` (array, required)

  - `items.products.key` (string, required)
    Example: platform

  - `items.products.status` (string, required)
    Example: active

  - `items.products.arr` (number, required)
    Example: 12000

  - `items.products.renewalDate` (string, required)
    Example: 2026-01-01

  - `items.products.engagement` (object, required)

  - `items.products.engagement.level` (string, required)
    Example: high

  - `items.products.upsell` (object, required)

  - `items.products.upsell.level` (string, required)
    Example: upsell

  - `items.products.metrics` (array, required)

  - `items.products.metrics.key` (string, required)
    Example: active_integrations

  - `items.products.metrics.value` (any, required)
    Example: 85

  - `items.sources` (array, required)

  - `items.sources.key` (string, required)
    Example: salesforce

  - `items.sources.externalId` (string, required)
    Example: 0010x000000aAAA

  - `items.updatedDate` (string, required)

  - `totalCount` (number, required)

