---
title: "Bulk read outlets"
method: GET
path: "/v1/outlets"
tags: ["Outlets"]
---

# Bulk read outlets

`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`

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

## Query parameters

- `skip` number
- `limit` number
- `sortBy` 'createdAt' | 'updatedAt' | 'name' | 'sequenceNumber'
- `sortOrder` 'asc' | 'desc'
- `searchByName` string
- `searchByAddress` string
- `searchByCity` string
- `searchByState` string
- `searchByCountry` string
- `searchByPostCode` string
- `searchByPhone` string
- `searchByAlias` string
- `searchByExternalId` string
- `createdAt` object
  - `gte` string, date-time
  - `lte` string, date-time
  - `gt` string, date-time
  - `lt` string, date-time
- `updatedAt` object
  - `gte` string, date-time
  - `lte` string, date-time
  - `gt` string, date-time
  - `lt` string, date-time
- `stations` string
- `stripeAccountId` string
- `externalId` string
- `source` string

## Response `200`

Successfully retrieved list of items

- object
  - `data` OutletResponseDto[]
    - `id` string: Unique identifier for the Outlet.
    - `createdAt` string, date-time: Timestamp when the Outlet was created.
    - `updatedAt` string, date-time: Timestamp when the Outlet was last updated.
    - `companyId` string: Company ID associated with the Outlet.
    - `name` string: Name of the Outlet.
    - `address` string: Primary address of the Outlet.
    - `city` string: City where the Outlet is located.
    - `state` string: State or province where the Outlet is located.
    - `country` string: Country where the Outlet is located.
    - `postCode` string: Post code or ZIP code of the Outlet.
    - `phone` string: Phone number of the Outlet.
    - `address2` string: Secondary address line of the Outlet.
    - `alias` string: Alias or alternate name for the Outlet used for Metorik Extension.
    - `timeZone` string: IANA timezone of the outlet. Falls back to Company.timeZone when absent.
    - `sequenceNumber` number: Sequence number for the Outlet (auto-generated).
    - `stations` string[]: List of station IDs associated with the Outlet.
    - `stripeAccountId` string: Stripe Connect account ID associated with the Outlet.
    - `stripe` object: Stripe Terminal configuration for the Outlet.
    - `externalId` string: External provider id for the Outlet (the source location id). Integration correlation key.
    - `source` string: Origin of the Outlet — the integration provider that created it, or "standalone".
    - `taxId` string: Tax ID associated with the Outlet.
  - `meta` object
    - `count` number: Total number of items matching the query filters
    - `skip` number: Number of items skipped
    - `limit` number: Maximum number of items returned

## Other responses

- `400`: Bad request. Returns validation errors or other request-related errors.
- `404`: The resource(s) were not found.

---

[API](https://skmtc.dev/finalpos/apis/final-pos-public-api.md) · [All operations](https://skmtc.dev/finalpos/apis/final-pos-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/finalpos/apis/final-pos-public-api/revisions/6a6842dcb479?raw)