Sign in

v1

latestOpenAPI 3.0.02026-08-0696238481.7 KB
In-Person Locations

List in-person locations

Fetches an paginated list of in-person locations

get/in-person/locations

Query parameters

ascendingboolean

Control the order (newest or oldest) in which the items are returned. false will arrange the results with newest first, whereas true shows oldest first. The default is false.

limitinteger
Example:10

Control how many items are return in a given page The max limit we allow is 50. The default is 10.

startsAfterstring
Example:iploc_01FCTS1XMKH9FF43CAFA4CXT3P_1641912473

A token to identify the item to start querying after. This is used to get the next page of results after a previous response returned a non-null paginationToken. The value of the paginationToken field from that response should be supplied here, to retrieve the next page of results for that timestamp range.

Headers

Accountstring
Example:ac_3fe8398f-8cdb-43a3-9be2-806c4f84c327

The linked accountId (use this when you want to list in person location under a linked account)

Response

The resource was retrieved successfully

paginationTokenstring nullable

A token to use for getting the next page of results - send the same request with this value in the 'paginationToken' query parameter. This field is null when there are no further items to return

Example response

{
  "items": [
    {
      "id": "iploc_01FCTS1XMKH9FF43CAFA4CXT3P",
      "name": "Head Office front desk",
      "address": {
        "lineOne": "123 Test Street",
        "lineTwo": "456 Test Lane",
        "city": "Manchester",
        "country": "GB",
        "postalCode": "M3 3AG",
        "region": "Greater Manchester"
      },
      "geoCoordinates": {
        "latitude": 51.1789,
        "longitude": 1.8262
      },
      "metadata": {
        "internalID": "1"
      },
      "createdTimestamp": 1470989538,
      "lastUpdatedTimestamp": 1470989538
    }
  ],
  "paginationToken": "iploc_01FCTS1XMKH9FF43CAFA4CXT3P_1641912473"
}