> For the complete documentation index, see [llms.txt](https://sandgarden.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://sandgarden.gitbook.io/docs/reference/users-api.md).

# Users API

This page covers direct integration with Doc Holiday's API.

All endpoints on this page require authenticated access; see [API overview](/docs/reference/api-overview.md) for how to create and send an API key.

### GET /api/v1/me

Returns the authenticated user as `ModelsGetUserResponse`, the same shape used by `GET /api/v1/users/{id}`.

| Parameter | Notes                        |
| --------- | ---------------------------- |
| none      | No query or path parameters. |

```bash
curl -H "Authorization: Bearer <token>" https://api.doc.holiday/api/v1/me
```

```json
{"id":"string","authId":"string","email":"string","name":"string","sfsToken":"","invitationAccepted":true,"orgId":"string","createdAt":"string","updatedAt":"string"}
```

Common errors: `400`, `500`.

### GET /api/v1/users

Returns `ModelsListUsersResponse` for users in the authenticated org, with `users`, `nextPageToken`, and `previousPageToken`.

| Parameter          | Notes                                      |
| ------------------ | ------------------------------------------ |
| email              | Filter by email.                           |
| name               | Filter by name.                            |
| authId             | Filter by auth ID.                         |
| query              | Free-text search.                          |
| roleIds            | Filter by role IDs.                        |
| noBuiltinRole      | Filters to users who hold no builtin role. |
| invitationAccepted | Filter by invitation state.                |
| shared pagination  | Shared pagination fields from the API.     |

```bash
curl -H "Authorization: Bearer <token>" "https://api.doc.holiday/api/v1/users?email=string"
```

```json
{"users":[{"id":"string","email":"string","name":"string"}],"nextPageToken":"string","previousPageToken":"string"}
```

Common errors: `400`, `500`.

### GET /api/v1/users/{id}

Returns one user in `ModelsGetUserResponse`.

| Parameter | Notes                    |
| --------- | ------------------------ |
| id        | Required path parameter. |

```bash
curl -H "Authorization: Bearer <token>" https://api.doc.holiday/api/v1/users/string
```

```json
{"id":"string","authId":"string","email":"string","name":"string","sfsToken":"","invitationAccepted":true,"orgId":"string","createdAt":"string","updatedAt":"string"}
```

Common errors: `400`, `500`.