---
title: "Get API Clients"
method: GET
path: "/connect/clients/"
tags: ["Clients"]
---

# Get API Clients

`GET /connect/clients/`

Returns all existing API clients.

## Response `200`

The array of Client objects

- ModelClient[]
  - `createTime` string — The date and time when this API client was created
  - `id` string — The ID assigned to this API client
  - `name` string — The client name
  - `note` string — An optional note to associate with this API client
  - `permissions` string[] — The list of permissions assigned to this client
  - `searchUsername` string — An optional Elasticsearch user that this client will run as when accessing event data
  - `secret` string — The generated client secret (only returned on new client creation and regeneration of the secret)
  - `updateTime` string — The date and time when this API client was last modified

## Other responses

- `401` — Request was not properly authenticated
- `403` — Insufficient permissions for this request
- `500` — Internal SOC error; review SOC logs

---

[API](https://skmtc.net/security-onion-solutions/apis/security-onion-connect-api.md) · [All operations](https://skmtc.net/security-onion-solutions/apis/security-onion-connect-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/security-onion-solutions/security-onion-connect-api/versions/0576ce393f8d/schema)