> ## Documentation Index
> Fetch the complete documentation index at: https://dkkangoyazlmteknolojiticareta.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Restaurants

> Retrieve all accessible restaurants/branches

## Overview

Retrieves all restaurants/branches accessible with your API key. A single API key can provide access to one or multiple restaurant locations.

## Headers

<ParamField header="Access-Token" type="string" required>
  Your API access token
</ParamField>

## Response

<ResponseField name="status" type="boolean">
  `true` if successful
</ResponseField>

<ResponseField name="data" type="array">
  Array of restaurant objects

  <Expandable title="Restaurant Object">
    <ResponseField name="id" type="string">
      Restaurant/branch UUID
    </ResponseField>

    <ResponseField name="name" type="string">
      Restaurant/branch name
    </ResponseField>
  </Expandable>
</ResponseField>

## Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET https://www.xn--dkkango-n2a.com/api/integrations/restaurants/get \
    -H 'Access-Token: your-access-token'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://www.xn--dkkango-n2a.com/api/integrations/restaurants/get',
    {
      headers: {
        'Access-Token': 'your-access-token'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://www.xn--dkkango-n2a.com/api/integrations/restaurants/get',
      headers={'Access-Token': 'your-access-token'}
  )

  data = response.json()
  ```

  ```php PHP theme={null}
  <?php
  $ch = curl_init();
  curl_setopt($ch, CURLOPT_URL, 'https://www.xn--dkkango-n2a.com/api/integrations/restaurants/get');
  curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
  curl_setopt($ch, CURLOPT_HTTPHEADER, array(
      'Access-Token: your-access-token'
  ));
  $response = curl_exec($ch);
  curl_close($ch);

  $data = json_decode($response, true);
  ?>
  ```
</CodeGroup>

## Success Response (200)

```json theme={null}
{
  "status": true,
  "data": [
    {
      "id": "8f2b9ce2-04de-4712-842d-a39f64596fdf",
      "name": "Akat Şube"
    },
    {
      "id": "0ca1d2b1-a199-4960-8617-83a659d890c8",
      "name": "Halaskargazi Şube"
    }
  ]
}
```

## Error Response (401)

```json theme={null}
{
  "status": false,
  "error": "yetkisiz erişim",
  "message": "Invalid or expired access token"
}
```

## Usage

<Steps>
  <Step title="Call on Startup">
    Fetch restaurant list when your POS application starts
  </Step>

  <Step title="Store Locally">
    Cache restaurant IDs and names in your local database
  </Step>

  <Step title="Use in Operations">
    Use restaurant IDs for status operations and filtering
  </Step>
</Steps>

## Multi-Branch Access

<Tabs>
  <Tab title="Single Branch">
    If your API key is branch-specific:

    ```json theme={null}
    {
      "data": [
        {
          "id": "8f2b9ce2-04de-4712-842d-a39f64596fdf",
          "name": "Akat Şube"
        }
      ]
    }
    ```

    You can only manage this one location.
  </Tab>

  <Tab title="Multiple Branches">
    If your API key is vendor-wide:

    ```json theme={null}
    {
      "data": [
        {
          "id": "8f2b9ce2-04de-4712-842d-a39f64596fdf",
          "name": "Akat Şube"
        },
        {
          "id": "0ca1d2b1-a199-4960-8617-83a659d890c8",
          "name": "Halaskargazi Şube"
        }
      ]
    }
    ```

    You can manage all returned locations.
  </Tab>
</Tabs>

<Info>
  The number of restaurants returned depends on how your API key was configured by Dükkango.
</Info>

## Related Endpoints

<CardGroup cols={2}>
  <Card title="Check Status" icon="circle-question" href="/api-reference/restaurants/status-get">
    Get restaurant open/closed status
  </Card>

  <Card title="Open Restaurant" icon="door-open" href="/api-reference/restaurants/status-open">
    Set restaurant to open
  </Card>

  <Card title="Close Restaurant" icon="door-closed" href="/api-reference/restaurants/status-close">
    Set restaurant to closed
  </Card>

  <Card title="Get Menu" icon="utensils" href="/api-reference/foods/get-foods">
    Fetch menu items for restaurants
  </Card>
</CardGroup>