Customers

7 endpoints

List customers

Get a list of customers within the authenticated tenant. Supports pagination with offset/limit.

Parameters
limit
integerMaximum number of results to return
offset
integerNumber of results to skip for pagination
order_by
stringField to order by
direction
stringSort direction
search
stringSearch pattern for company name, first name, last name
Responses
200Successfully retrieved customer list
401Authentication required
403Access denied - insufficient permissions
500Internal server error
Code Examples
example.ts
typescript
1import { Limbos } from '@limbos/sdk';
2
3const client = new Limbos({
4  apiKey: process.env.LIMBOS_API_KEY,
5});
6
7const result = await client.customers.list({
8  limit: 1,
9  offset: 1,
10  order_by: 'example',
11  direction: 'example',
12  search: 'example',
13});
14
15console.log(result);