API Reference
Knowledge Base

List all customer addresses

get
https://api.katanamrp.com/v1/customer_addresses

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
ids
array of integers

Filters customer addresses by an array of IDs

ids
customer_ids
array of integers

Filters customer addresses by an array of customer IDs

customer_ids
enum

Filters customer addresses by a entity_type

Allowed:
string

Filters customer addresses by a first_name

string

Filters customer addresses by a last_name

string

Filters customer addresses by an company

string

Filters customer addresses by a line_1

string

Filters customer addresses by a line_2

string

Filters customer addresses by a city

string

Filters customer addresses by a state

string

Filters customer addresses by a zip

string

Filters customer addresses by a country

string

Filters customer addresses by a phone

boolean

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

string

Used for pagination (default is 50)

string

Used for pagination (default is 1)

string

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

string

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

string

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

string

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

Responses

Updated about 2 months ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Choose an example:
application/json

Updated about 2 months ago

Did this page help you?