List locations
Every location of your organization (or of the key’s customer), by
customer and then by creation. With customer the list is that customer’s
(the same list as under /customers/{customer}/locations), and a customer
that is not yours is 404. With client_reference_id the list holds every
location that carries that value (it is not unique), narrowed to the
customer when one is named; an unknown value is an empty list.
A search reads only so many rows in one request: it may answer fewer
than limit objects, even none, with has_more true and a
next_cursor, which you send as starting_after (or ending_before)
to go on until has_more is false.
Scope: customers:read.
Authentication
A restricted API key, tc_rk_live_ and 32 characters. Send it as Authorization: Bearer <key>. A key lists its scopes, and each operation below names the one it needs; a key may also be limited to one customer. An owner or a developer of the organization makes a key in the dashboard, under API keys, after a code sent to their e-mail. The key is shown once, when it is made. An owner or a developer can revoke it there, and a revoked key stops working within a minute.
Query parameters
The id of the last object of the page you hold: returns the page that
follows it. In a search by client_reference_id the answer can be a
short page, or none, with has_more true and a next_cursor: send that
instead, and go on until has_more is false.
The id of the first object of the page you hold: returns the page
that precedes it. Not together with starting_after. In a search by
client_reference_id read backward, the next_cursor of the answer
when it has one.
Only the locations that carry this client reference id (1 to 128 characters). It is not unique, so the list can hold many; an unknown value is an empty list.
Only the locations of this customer: its id.
Response
Whether another page follows. Ask for it with starting_after
set to the id of the last object here, or, when the answer has
a next_cursor, with that. A search by client_reference_id
can answer a short page, or none, with has_more true: it
reads only so many rows in one request, and next_cursor is
the way on.
Always list.
Only in the answer to a search (client_reference_id) that
stopped before it could fill the page: it read all the rows it
may in one request. Then data holds what it found so
far, possibly nothing, has_more is true, and this is the
position to continue from: pass it as starting_after (or as
ending_before, if you page backward) in place of the id of
the last object. It is an id of the kind of the list, but not
necessarily the id of an object in data. Left out otherwise.