List all customers

get

https://api.katanamrp.com/v1/customers

Returns a list of customers you’ve previously created. The customers are returned in sorted order, with the most recent customers appearing first.

Query Params

name

string

Filters customers by name

first_name

string

Filters customers by first name

last_name

string

Filters customers by last name

company

string

Filters customers by company

ids

array of integers

Filters customers by an array of IDs

ids

string

Filters customers by an email

phone

string

Filters customers by a phone number

currency

string

Filters customers by currency

reference_id

string

Filters customers by a reference ID

category

string

Filters customers by a category

include_deleted

boolean

Soft-deleted data is excluded from result set by default. Set to true to include it.

limit

string

Used for pagination (default is 50)

page

string

Used for pagination (default is 1)

created_at_min

string

Minimum value for created_at range. Must be compatible with ISO 8601 format

created_at_max

string

Maximum value for created_at range. Must be compatible with ISO 8601 format

updated_at_min

string

Minimum value for updated_at range. Must be compatible with ISO 8601 format

updated_at_max

string

Maximum value for updated_at range. Must be compatible with ISO 8601 format

Responses

Language

Credentials

Bearer

Response

Choose an example:

application/json

200List of customers

401Make sure you've entered your API token correctly.

429The rate limit has been reached. Please try again later.

500The server encountered an error. If this persists, please contact support