Outlets

Bulk read outlets

Retrieves a list of outlets. Supports filtering by fields, sorting, and pagination.

get/v1/outlets

Request

  • Base URL: https://api.finalpos.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.finalpos.com/v1/outlets
  • Auth: API key in header x-api-key

Query parameters

skipnumber

Number of records to skip (default: 0)

limitnumber

Maximum number of records to return (default: 100, max: 1000)

sortBy'createdAt' | 'updatedAt' | 'name' | 'sequenceNumber'

Field name to sort results by

sortOrder'asc' | 'desc'

Sort direction (default: asc)

searchByNamestring

Field name to search by (case-insensitive partial match)

searchByAddressstring

Field name to search by (case-insensitive partial match)

searchByCitystring

Field name to search by (case-insensitive partial match)

searchByStatestring

Field name to search by (case-insensitive partial match)

searchByCountrystring

Field name to search by (case-insensitive partial match)

searchByPostCodestring

Field name to search by (case-insensitive partial match)

searchByPhonestring

Field name to search by (case-insensitive partial match)

searchByAliasstring

Field name to search by (case-insensitive partial match)

searchByExternalIdstring

Field name to search by (case-insensitive partial match)

gtestring date-time
ltestring date-time
gtstring date-time
ltstring date-time

Filter by createdAt using range operators

gtestring date-time
ltestring date-time
gtstring date-time
ltstring date-time

Filter by updatedAt using range operators

stationsstring

Filter by stations. Supports comma-separated values for matching any item in the array

stripeAccountIdstring

Filter by stripeAccountId

externalIdstring

Filter by externalId

sourcestring

Filter by source

Response

Successfully retrieved list of items

Example response

{
  "data": [
    {
      "id": "o1p2q3r4s5t6u7v8w9x0y1z2",
      "createdAt": "2025-12-07T19:31:48.436+00:00",
      "updatedAt": "2025-12-07T19:35:48.436+00:00",
      "companyId": "o1p2q3r4s5t6u7v8w9x0y1z2",
      "name": "Main Store",
      "address": "26 Federal Plaza, New York, NY 10278, USA",
      "city": "New York",
      "state": "NY",
      "country": "US",
      "postCode": "10278",
      "phone": "+12323232323",
      "address2": "Suite 100",
      "alias": "HQ",
      "timeZone": "America/St_Johns",
      "sequenceNumber": 45,
      "stations": [
        "o1p2q3r4s5t6u7v8w9x0y1z2"
      ],
      "stripeAccountId": "o1p2q3r4s5t6u7v8w9x0y1z2",
      "stripe": {
        "locationId": "tml_XXXXXXXXXX"
      },
      "externalId": "L1234567890",
      "source": "square",
      "taxId": "23"
    }
  ],
  "meta": {
    "count": 1450,
    "limit": 100
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.