# List outlets

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://apidocs.cata.sg/pos-integration-service-api/api/v-1/outlets/llms.txt.
> For full documentation content, see https://apidocs.cata.sg/pos-integration-service-api/api/v-1/outlets/llms-full.txt.

GET http://localhost:8080/api/v1/outlets

Returns outlets for the tenant. Filter by provider via `X-Provider` header.
If `X-Provider` is omitted, returns all outlets regardless of provider.
Results are sorted alphabetically by name.


Reference: https://apidocs.cata.sg/pos-integration-service-api/api/v-1/outlets/list-outlets

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: collection
  version: 1.0.0
paths:
  /api/v1/outlets:
    get:
      operationId: list-outlets
      summary: List outlets
      description: >
        Returns outlets for the tenant. Filter by provider via `X-Provider`
        header.

        If `X-Provider` is omitted, returns all outlets regardless of provider.

        Results are sorted alphabetically by name.
      tags:
        - subpackage_api.subpackage_api/v1.subpackage_api/v1/outlets
      parameters:
        - name: X-Api-Key
          in: header
          required: true
          schema:
            type: string
        - name: X-Tenant-ID
          in: header
          description: Tenant identifier
          required: false
          schema:
            type: string
        - name: X-Provider
          in: header
          description: POS provider name (validated against tenant settings)
          required: false
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api_v1_outlets_List outlets_Response_200'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1OutletsRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1OutletsRequestUnauthorizedError'
servers:
  - url: http://localhost:8080
components:
  schemas:
    ApiV1OutletsGetResponsesContentApplicationJsonSchemaStoresItems:
      type: object
      properties:
        uuid:
          type: string
          format: uuid
        name:
          type: string
      required:
        - uuid
        - name
      title: ApiV1OutletsGetResponsesContentApplicationJsonSchemaStoresItems
    api_v1_outlets_List outlets_Response_200:
      type: object
      properties:
        stores:
          type: array
          items:
            $ref: >-
              #/components/schemas/ApiV1OutletsGetResponsesContentApplicationJsonSchemaStoresItems
        total:
          type: integer
      required:
        - stores
        - total
      title: api_v1_outlets_List outlets_Response_200
    ApiV1OutletsGetResponsesContentApplicationJsonSchemaError:
      type: object
      properties:
        code:
          type: integer
        message:
          type: string
        details:
          type: string
        field:
          type: string
      required:
        - code
        - message
        - details
        - field
      title: ApiV1OutletsGetResponsesContentApplicationJsonSchemaError
    GetApiV1OutletsRequestBadRequestError:
      type: object
      properties:
        error:
          $ref: >-
            #/components/schemas/ApiV1OutletsGetResponsesContentApplicationJsonSchemaError
      required:
        - error
      title: GetApiV1OutletsRequestBadRequestError
    GetApiV1OutletsRequestUnauthorizedError:
      type: object
      properties:
        error:
          $ref: >-
            #/components/schemas/ApiV1OutletsGetResponsesContentApplicationJsonSchemaError
      required:
        - error
      title: GetApiV1OutletsRequestUnauthorizedError
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key

```

## SDK Code Examples

```python api_v1_outlets_List outlets_example
import requests

url = "http://localhost:8080/api/v1/outlets"

headers = {
    "X-Tenant-ID": "string",
    "X-Provider": "cata",
    "X-Api-Key": "<apiKey>"
}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript api_v1_outlets_List outlets_example
const url = 'http://localhost:8080/api/v1/outlets';
const options = {
  method: 'GET',
  headers: {'X-Tenant-ID': 'string', 'X-Provider': 'cata', 'X-Api-Key': '<apiKey>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go api_v1_outlets_List outlets_example
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:8080/api/v1/outlets"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Tenant-ID", "string")
	req.Header.Add("X-Provider", "cata")
	req.Header.Add("X-Api-Key", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby api_v1_outlets_List outlets_example
require 'uri'
require 'net/http'

url = URI("http://localhost:8080/api/v1/outlets")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["X-Tenant-ID"] = 'string'
request["X-Provider"] = 'cata'
request["X-Api-Key"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java api_v1_outlets_List outlets_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("http://localhost:8080/api/v1/outlets")
  .header("X-Tenant-ID", "string")
  .header("X-Provider", "cata")
  .header("X-Api-Key", "<apiKey>")
  .asString();
```

```php api_v1_outlets_List outlets_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'http://localhost:8080/api/v1/outlets', [
  'headers' => [
    'X-Api-Key' => '<apiKey>',
    'X-Provider' => 'cata',
    'X-Tenant-ID' => 'string',
  ],
]);

echo $response->getBody();
```

```csharp api_v1_outlets_List outlets_example
using RestSharp;

var client = new RestClient("http://localhost:8080/api/v1/outlets");
var request = new RestRequest(Method.GET);
request.AddHeader("X-Tenant-ID", "string");
request.AddHeader("X-Provider", "cata");
request.AddHeader("X-Api-Key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift api_v1_outlets_List outlets_example
import Foundation

let headers = [
  "X-Tenant-ID": "string",
  "X-Provider": "cata",
  "X-Api-Key": "<apiKey>"
]

let request = NSMutableURLRequest(url: NSURL(string: "http://localhost:8080/api/v1/outlets")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```