Fetches a list of locations.

get

https://api.spirii.com/v2/locations

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

nextPageCursor

string

Cursor to be used to request the next page.

previousPageCursor

string

Cursor to be used to request the previous page.

limit

integer

1 to 100

Defaults to 25

Limit amount of returned records.

ownerId

number

deprecated

Legacy ID of the customer that 'owns' the location. An 'owner' represents a 'customer' in the Spirii Connect portal/UI. While the term 'ownerId' is outdated, this ID is retained for backward compatibility with legacy systems.

customerId

number

deprecated

Deprecated: use 'customerIds' instead. ID of the customer that 'owns' the location. The 'customerId' is the unique identifier for a customer. The 'customer' can be found in the Connect Customer management page. This customer ID corresponds with the customer ID that can be retrieved from the Customer v2 API.

customerIds

array of numbers

List of IDs of customers that 'own' the locations. The 'customerIds' are unique identifiers for customers. The 'customers' can be found in the Connect Customer management page. These customer IDs correspond with the customer IDs that can be retrieved from the Customer v2 API.

customerIds

tariffId

string

Uniquely identifies the tariff within the CPO’s platform

ids

array of numbers

List of IDs that Uniquely identifies the location

ids

priority

boolean

Retrieve only priority/non-priority locations

Responses

400

Bad Request provided. A message will describe the issue.

403

Authorization header token is invalid or not provided.

500

Internal Server Error.

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200