API Reference
Knowledge Base

List all locations

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

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

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

Filters locations by an array of IDs

ids
string

Filters locations by a name

string

Filters locations by a legal_name

integer

Filters locations by an address_id

boolean

Filters locations by a sales_allowed

boolean

Filters locations by a manufacturing_allowed

boolean

Filters locations by a purchases_allowed

integer

Filters locations by a rank

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 8 months ago

Language
Credentials
Bearer
LoadingLoading…
Response
Choose an example:
application/json

Updated 8 months ago