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

# List Clients

> Syteca Data Connector REST API endpoint to retrieve the list of Clients — returns each Client's GUID and name.

Returns the full list of Syteca Clients visible to the API key's user — each Client's GUID and display name.

```http theme={"system"}
GET https://<hostname>/ekranapi/client
```

## Authentication

<ParamField header="ApiKey" type="string" required>
  Your Active API Key from the Management Tool. See [Manage → Get an API key](/docs/api/data-connector/manage#get-an-api-key).
</ParamField>

Example header:

```text theme={"system"}
ApiKey: xJ)tsCNcpj)l+]}(@_|lt!t………
```

## Query parameters

*This endpoint takes no query parameters — the response always contains the full list of Clients visible to the API key's user.*

## Response (200 OK)

<ResponseField name="item1" type="string">
  The GUID of the Client.
</ResponseField>

<ResponseField name="item2" type="string">
  The name of the Client.
</ResponseField>

<Note>
  The `item1` / `item2` field names reflect the API's underlying .NET Tuple serialization — they are preserved verbatim in the response.
</Note>

## Example

<RequestExample>
  ```bash cURL theme={"system"}
  curl -X GET https://<hostname>/ekranapi/client \
    -H "ApiKey: xJ)tsCNcpj)l+]}(@_|lt!t………"
  ```
</RequestExample>

<ResponseExample>
  ```json 200 OK theme={"system"}
  [
    {
      "item1": "421be78f-e21f-4585-ac01-2050f944b7ef",
      "item2": "clientname1"
    },
    {
      "item1": "222be7p8-e21f-3432-ac11-2050f987b7ef",
      "item2": "clientname2"
    }
  ]
  ```
</ResponseExample>

## Errors

See [Status codes](/docs/api/data-connector/api-reference#status-codes) for the full mapping. Common errors:

* **403 Forbidden** — the Data Connector has been [removed from the Applications tab](/docs/api/data-connector/manage#deactivate-the-data-connector). Reinstall to restore.
* **503 Service Unavailable** — the Syteca Application Server is stopped or unreachable.

## Related

<CardGroup cols={2}>
  <Card title="API reference" icon="square-code" href="/docs/api/data-connector/api-reference">
    Base URL, authentication, status codes, all endpoints.
  </Card>

  <Card title="List sessions" icon="list" href="/docs/api/data-connector/endpoints/get-sessions">
    Use the GUIDs from this endpoint to look up sessions per Client.
  </Card>
</CardGroup>
