# List Genies

> The Genies of the workspace in one region, newest first.

Source: https://docs.stacksync.com/api-reference/genies/list_genies

`GET https://api.stacksync.com/v1/workspaces/{workspace_id}/genies`

- Operation: `list_genies`
- Resource: Genies
- Access: read-only

## Authentication

- `Authorization: Bearer <key>`: A workspace API key (workspace_…, created by a workspace owner under Workspace settings > Stacksync API) acts with editor rights on that workspace only; a user API key (user_…, created under Profile > Stacksync API) acts as that user in every workspace they belong to. POST, PUT and PATCH requests must send Content-Type: application/json. Every authentication failure answers 403.

## Path parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `workspace_id` | integer | Yes | The workspace. List the ones your key can reach with GET /v1/workspaces. |

## Query parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `limit` | integer, 1 to 200, default 50 | No | Maximum number of items returned, at most 200 |
| `offset` | integer, at least 0, default 0 | No | Number of items skipped before the first one returned |
| `region` | string (besg \| usnv) | Yes | Region to list: besg or usnv |
| `folder_id` | string (uuid) \| null | No | Only the genies of this folder; every genie of the workspace when absent |
| `search` | string \| null, 1 to 255 characters | No | Only genies whose name contains this text |

## Returns

### 200 OK

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `data` | array of object (GenieSummary) | Yes |  |
| `data[].genie_id` | string | Yes |  |
| `data[].name` | string | Yes |  |
| `data[].status` | string \| null | No |  |
| `data[].region` | string (besg \| usnv) | Yes |  |
| `data[].apps` | array of string | No | The apps its skills act in |
| `data[].folder_id` | string \| null | No |  |
| `data[].last_modified_time` | string (date-time) \| null | No |  |
| `has_more` | boolean | Yes | Whether more items follow this page: request the next one with offset + limit |
| `limit` | integer | Yes |  |
| `offset` | integer | Yes |  |

## Example request

```bash
curl -X GET "https://api.stacksync.com/v1/workspaces/{workspace_id}/genies?region=besg" \
  -H "Authorization: Bearer $STACKSYNC_API_KEY"
```

## Example response (200)

```json
{
  "data": [
    {
      "genie_id": "<genie_id>",
      "name": "<name>",
      "status": "<status>",
      "region": "besg",
      "apps": [
        "<apps>"
      ],
      "folder_id": "<folder_id>",
      "last_modified_time": "2027-01-15T09:00:00Z"
    }
  ],
  "has_more": false,
  "limit": 0,
  "offset": 0
}
```

## Errors

| Status | Meaning | Body |
| --- | --- | --- |
| 400 | Bad Request | `{ "error": string, "msg": string, "field": string \| null }` |
| 403 | Forbidden | `{ "error": string, "msg": string, "field": string \| null }` |
| 404 | Not Found | `{ "error": string, "msg": string, "field": string \| null }` |

## Related

- [API Reference overview](https://docs.stacksync.com/api-reference): base URLs, regions, pagination, idempotency and errors
- [Authentication](https://docs.stacksync.com/api-reference/authentication): API keys and the 403 answers
- OpenAPI document: https://docs.stacksync.com/openapi.json
- [List Genie logs](https://docs.stacksync.com/api-reference/genies/list_genie_logs)
- [Get a Genie](https://docs.stacksync.com/api-reference/genies/get_genie)
- [Create a genie](https://docs.stacksync.com/api-reference/genies/create_genie)
- [Update a Genie](https://docs.stacksync.com/api-reference/genies/update_genie)
- [Delete a Genie](https://docs.stacksync.com/api-reference/genies/delete_genie)
- [Check a Genie email alias](https://docs.stacksync.com/api-reference/genies/check_genie_email_alias)