# List in-person locations

Fetches an paginated list of in-person locations

Endpoint: GET /in-person/locations
Version: 1.1.0
Security: secretApiKeyAuth

## Header parameters:

  - `Account` (string)
    The linked accountId (use this when you want to list in person location under a linked account)
    Example: "ac_3fe8398f-8cdb-43a3-9be2-806c4f84c327"

## Query parameters:

  - `ascending` (boolean)
    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.

  - `limit` (integer)
    Control how many items are return in a given page The max limit we allow is 50. The default is 10.
    Example: 10

  - `startsAfter` (string)
    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.
    Example: "iploc_01FCTS1XMKH9FF43CAFA4CXT3P_1641912473"

## Response 200 fields (application/json):

  - `items` (array)

  - `items.id` (string)
    The unique Id of the location
    Example: "iploc_01FCTS1XMKH9FF43CAFA4CXT3P"

  - `items.name` (string)
    Your name for the location. This can be used for display purposes.

  - `items.address` (object)

  - `items.address.lineOne` (string)
    First line of the address

  - `items.address.lineTwo` (string,null)
    Second line of the address

  - `items.address.city` (string)
    The address city/town

  - `items.address.country` (string)
    The two-character ISO country code
    Example: "GB"

  - `items.address.postalCode` (string)
    The postal code/zip of the address

  - `items.address.region` (string)
    The state/county/province/region Required if the address is in the US/Canada and must be a 2-character ISO state/province code

  - `items.geoCoordinates` (any,null)

  - `items.metadata` (object)
    Your own custom key-value data for this object. These will be sent with any associated events on your webhooks. You can have a maximum of 10 pieces of metadata.

Keys must be between 1 and 30 characters in length.

Values must be between 1 and 250 characters in length.
    Example: {"internalID":"1"}

  - `items.createdTimestamp` (integer)
    The epoch timestamp (seconds) when the object was created
    Example: 1470989538

  - `items.lastUpdatedTimestamp` (integer)
    The epoch timestamp (seconds) when the object was last updated
    Example: 1470989538

  - `paginationToken` (string)
    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: "iploc_01FCTS1XMKH9FF43CAFA4CXT3P_1641912473"

## Response 400 fields (application/json):

  - `requestId` (string)
    Example: "b83f2653-06d7-44a9-a548-5825e8186004"

  - `code` (string)
    Example: "400"

  - `errors` (array)

  - `errors.message` (string)
    Example: "Required property 'amount' not found in JSON"

## Response 500 fields (application/json):

  - `requestId` (string)
    Example: "b83f2653-06d7-44a9-a548-5825e8186004"

  - `code` (string)
    Example: "400"

  - `errors` (array)

  - `errors.message` (string)
    Example: "Required property 'amount' not found in JSON"