# 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");
```

##


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.protokol.com/developers/sdk/guardian/api-endpoints.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.