> For the complete documentation index, see [llms.txt](https://docs.protokol.com/developers/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.protokol.com/developers/sdk/guardian/api-endpoints.md).

# API Endpoints

{% hint style="info" %}
Default nameservice prefix is `/api/guardian`
{% endhint %}

## List Of Configurations Endpoints

| Endpoints                                                                      | Description                                 | Type |
| ------------------------------------------------------------------------------ | ------------------------------------------- | ---- |
| [/configurations](/developers/sdk/nameservice/api-endpoints/configurations.md) | Returns configurations for Guardian plugins | GET  |

## List Of Groups Endpoints

| Endpoints                                                                                   | Description                      | Type |
| ------------------------------------------------------------------------------------------- | -------------------------------- | ---- |
| [/groups](/developers/sdk/guardian/api-endpoints/groups.md#groups-1)                        | Returns all Groups               | GET  |
| [/groups/:name](/developers/sdk/guardian/api-endpoints/groups.md#groups-name)               | Returns Group by its name        | GET  |
| [/groups/:name/users](/developers/sdk/guardian/api-endpoints/groups.md#users-by-group-name) | Returns Users of a Group by name | GET  |

## List Of Users Endpoints

| Endpoints                                                                            | Description                             | Type |
| ------------------------------------------------------------------------------------ | --------------------------------------- | ---- |
| [/users](/developers/sdk/guardian/api-endpoints/users.md#users-1)                    | Returns all Users                       | GET  |
| [/users/:id](/developers/sdk/guardian/api-endpoints/users.md#users-id)               | Returns User by Publickey               | GET  |
| [/users/:id/groups](/developers/sdk/guardian/api-endpoints/users.md#users-id-groups) | Returns All Groups of User by Publickey | GET  |

## Guardian Client

{% hint style="info" %}
A Light Typescript Client Supporting Guardian REST API
{% endhint %}

### Installation

#### [yarn](https://classic.yarnpkg.com/lang/en/)

```
yarn add @protokol/client
```

#### [pnpm](https://pnpm.js.org/)

```
pnpm add @protokol/client
```

#### [npm](https://www.npmjs.com/)

```
npm install @protokol/client
```

### Initialization

```typescript
import { ProtokolConnection } from "@protokol/client";

const connection = new ProtokolConnection("https://explorer.protokol.sh/api");
```

##