GET/v1/crm/customers

GET /v1/crm/customers

Scopes: crm:customers:read

Requires scope: crm:customers:read.

Parameters

Name	In	Type	Required
`starting_after`	query	`string`	no
`ending_before`	query	`string`	no
`limit`	query	`integer<int32>`	no
`search_term`	query	`string`	no

Response (200)

Field	Type	Required
`data`	`CustomerSummary[]`	no
`hasMore`	`boolean`	no
`startingAfterCursor`	`string`	no
`endingBeforeCursor`	`string`	no

Examples

import { SolidCommerceClient } from '@solidcommerce/sdk';

const client = new SolidCommerceClient({
  apiKey: process.env.SOLIDCOMMERCE_API_KEY!,
});

const { data, error } = await client.raw.GET('/v1/crm/customers', {
  // params: { path: { id: '...' }, query: { limit: 25 } },
  // body: { /* request body */ },
});

if (error) throw error;
console.log(data);