# Get all outlets

Retrieves a list of all outlets. Supports pagination and filtering by companyId.

Endpoint: GET /v1/api/outlets
Version: 1.2.4
Security: X-Api-Key

## Query parameters:

  - `skip` (number)
    Number of records to skip (must be a multiple of limit for accurate page numbers)

  - `limit` (number)
    Maximum number of records to return

## Response 200 fields (application/json):

  - `id` (string)
    Unique identifier for the Outlet.
    Example: "o1p2q3r4s5t6u7v8w9x0y1z2"

  - `createdAt` (string)
    Timestamp when the Outlet was created.
    Example: "2025-12-07T19:31:48.436+00:00"

  - `updatedAt` (string)
    Timestamp when the Outlet was last updated.
    Example: "2025-12-07T19:35:48.436+00:00"

  - `companyId` (string)
    Company ID associated with the Outlet.
    Example: "o1p2q3r4s5t6u7v8w9x0y1z2"

  - `name` (string)
    Name of the Outlet.
    Example: "Main Store"

  - `address` (string)
    Primary address of the Outlet.
    Example: "26 Federal Plaza, New York, NY 10278, USA"

  - `city` (string)
    City where the Outlet is located.
    Example: "New York"

  - `state` (string)
    State or province where the Outlet is located.
    Example: "NY"

  - `country` (string)
    Country where the Outlet is located.
    Example: "US"

  - `postCode` (string)
    Post code or ZIP code of the Outlet.
    Example: "10278"

  - `phone` (string)
    Phone number of the Outlet.
    Example: "+12323232323"

  - `address2` (string)
    Secondary address line of the Outlet.
    Example: "Suite 100"

  - `alias` (string)
    Alias or alternate name for the Outlet.
    Example: "HQ"

  - `sequenceNumber` (number)
    Sequence number for the Outlet (auto-generated).
    Example: 45

  - `stations` (array)
    List of station IDs associated with the Outlet.
    Example: ["o1p2q3r4s5t6u7v8w9x0y1z2"]

  - `stripeAccountId` (string)
    Stripe Connect account ID associated with the Outlet.
    Example: "o1p2q3r4s5t6u7v8w9x0y1z2"

  - `stripe` (object)
    Stripe Terminal configuration for the Outlet.
    Example: {"locationId":"tml_XXXXXXXXXX"}

  - `taxId` (string)
    Tax ID associated with the Outlet.
    Example: "23"

## Response 400 fields (application/json):

  - `statusCode` (number, required)
    HTTP status code
    Example: 400

  - `message` (string, required)
    Error message describing what went wrong
    Example: "Validation failed: Field `schemaField` is required."

  - `error` (string, required)
    Error type/name
    Enum: "Bad Request", "Unauthorized", "Forbidden", "Not Found", "Conflict", "Unprocessable Entity", "Internal Server Error"

## Response 404 fields (application/json):

  - `statusCode` (number, required)
    HTTP status code
    Example: 404

  - `message` (string, required)
    Error message describing what went wrong
    Example: "The resource was not found."

  - `error` (string, required)
    Error type/name
    Enum: "Bad Request", "Unauthorized", "Forbidden", "Not Found", "Conflict", "Unprocessable Entity", "Internal Server Error"