> **Can't find what you're looking for?** Use `search_docs` on the docs MCP server at `https://docs.prividium.com/api/mcp` to find what you need.
>
> **Have feedback?** Use `submit_feedback` on the same MCP server.

# tenants

## GET /tenants/

`GET /tenants/`

Search tenants with pagination

### Query parameters

- `limit` `integer`
- `offset` `integer`

### Responses

#### `200`: Default Response

Body (`application/json`):

- `items` `object[]` _(required)_
  - `id` `string` _(required)_
  - `name` `string` _(required)_
  - `publicKey` `string` _(required)_
  - `createdAt` `string <date-time>` _(required)_
  - `updatedAt` `string <date-time>` _(required)_
  - `defaultRoles` `object[]` _(required)_
    - `id` `string` _(required)_
    - `roleName` `string` _(required)_
    - `systemPermissions` `string[]`
    - `isSystemRole` `boolean`
    - `organizationId` `string | null`
    - `createdAt` `string <date-time>`
    - `updatedAt` `string <date-time>`
- `pagination` `object` _(required)_
  - `currentPage` `number` _(required)_
  - `totalPages` `number` _(required)_
  - `totalItems` `number` _(required)_
  - `limit` `number` _(required)_
  - `offset` `number` _(required)_

#### `401`: Default Response

Body (`application/json`):

- `error` `object` _(required)_
  - `code` `string` _(required)_
  - `message` `string` _(required)_
  - `issues` `unknown[]`

#### `403`: Default Response

Body (`application/json`):

- `error` `object` _(required)_
  - `code` `string` _(required)_
  - `message` `string` _(required)_
  - `issues` `unknown[]`

### Example request

```bash
curl '/api/tenants/?limit=10&offset=0'
```

```ts
fetch('/api/tenants/?limit=10&offset=0')
```

## POST /tenants/

`POST /tenants/`

Creates a new tenant

### Request body (required) (`application/json`)

- `name` `string` _(required)_
- `publicKey` `string` _(required)_
- `defaultRoles` `object[]` _(required)_
  - `id` `string` _(required)_

### Responses

#### `200`: Default Response

Body (`application/json`):

- `id` `string` _(required)_
- `name` `string` _(required)_
- `publicKey` `string` _(required)_
- `createdAt` `string <date-time>` _(required)_
- `updatedAt` `string <date-time>` _(required)_
- `defaultRoles` `object[]` _(required)_
  - `id` `string` _(required)_
  - `roleName` `string` _(required)_
  - `systemPermissions` `string[]`
  - `isSystemRole` `boolean`
  - `organizationId` `string | null`
  - `createdAt` `string <date-time>`
  - `updatedAt` `string <date-time>`

#### `400`: Default Response

Body (`application/json`):

- `error` `object` _(required)_
  - `code` `string` _(required)_
  - `message` `string` _(required)_
  - `issues` `unknown[]`

#### `403`: Default Response

Body (`application/json`):

- `error` `object` _(required)_
  - `code` `string` _(required)_
  - `message` `string` _(required)_
  - `issues` `unknown[]`

### Example request

```bash
curl /api/tenants/ \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "string",
  "publicKey": "string",
  "defaultRoles": [
    {
      "id": "string"
    }
  ]
}'
```

```ts
fetch('/api/tenants/', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'string',
    publicKey: 'string',
    defaultRoles: [
      {
        id: 'string'
      }
    ]
  })
})
```

## GET /tenants/{id}

`GET /tenants/{id}`

Get tenant by id

### Path parameters

- `id` `string` _(required)_

### Responses

#### `200`: Default Response

Body (`application/json`):

- `id` `string` _(required)_
- `name` `string` _(required)_
- `publicKey` `string` _(required)_
- `createdAt` `string <date-time>` _(required)_
- `updatedAt` `string <date-time>` _(required)_
- `defaultRoles` `object[]` _(required)_
  - `id` `string` _(required)_
  - `roleName` `string` _(required)_
  - `systemPermissions` `string[]`
  - `isSystemRole` `boolean`
  - `organizationId` `string | null`
  - `createdAt` `string <date-time>`
  - `updatedAt` `string <date-time>`

#### `401`: Default Response

Body (`application/json`):

- `error` `object` _(required)_
  - `code` `string` _(required)_
  - `message` `string` _(required)_
  - `issues` `unknown[]`

#### `403`: Default Response

Body (`application/json`):

- `error` `object` _(required)_
  - `code` `string` _(required)_
  - `message` `string` _(required)_
  - `issues` `unknown[]`

#### `404`: Default Response

Body (`application/json`):

- `error` `object` _(required)_
  - `code` `string` _(required)_
  - `message` `string` _(required)_
  - `issues` `unknown[]`

### Example request

```bash
curl /api/tenants/string
```

```ts
fetch('/api/tenants/string')
```

## DELETE /tenants/{id}

`DELETE /tenants/{id}`

Updates a tenant by id

### Path parameters

- `id` `string` _(required)_

### Responses

#### `204`: Default Response

#### `401`: Default Response

Body (`application/json`):

- `error` `object` _(required)_
  - `code` `string` _(required)_
  - `message` `string` _(required)_
  - `issues` `unknown[]`

#### `403`: Default Response

Body (`application/json`):

- `error` `object` _(required)_
  - `code` `string` _(required)_
  - `message` `string` _(required)_
  - `issues` `unknown[]`

#### `404`: Default Response

Body (`application/json`):

- `error` `object` _(required)_
  - `code` `string` _(required)_
  - `message` `string` _(required)_
  - `issues` `unknown[]`

### Example request

```bash
curl /api/tenants/string \
  --request DELETE
```

```ts
fetch('/api/tenants/string', {
  method: 'DELETE'
})
```

## GET /tenants/{id}/users

`GET /tenants/{id}/users`

Get users for a tenant

### Path parameters

- `id` `string` _(required)_

### Query parameters

- `limit` `integer`
- `offset` `integer`

### Responses

#### `200`: Default Response

Body (`application/json`):

- `items` `object[]` _(required)_
  - `id` `string` _(required)_
  - `walletAddresses` `object[]` _(required)_
    - `walletAddress` `string` _(required)_
  - `displayName` `string` _(required)_
- `pagination` `object` _(required)_
  - `currentPage` `number` _(required)_
  - `totalPages` `number` _(required)_
  - `totalItems` `number` _(required)_
  - `limit` `number` _(required)_
  - `offset` `number` _(required)_

#### `400`: Default Response

Body (`application/json`):

- `error` `object` _(required)_
  - `code` `string` _(required)_
  - `message` `string` _(required)_
  - `issues` `unknown[]`

#### `401`: Default Response

Body (`application/json`):

- `error` `object` _(required)_
  - `code` `string` _(required)_
  - `message` `string` _(required)_
  - `issues` `unknown[]`

#### `403`: Default Response

Body (`application/json`):

- `error` `object` _(required)_
  - `code` `string` _(required)_
  - `message` `string` _(required)_
  - `issues` `unknown[]`

#### `404`: Default Response

Body (`application/json`):

- `error` `object` _(required)_
  - `code` `string` _(required)_
  - `message` `string` _(required)_
  - `issues` `unknown[]`

### Example request

```bash
curl '/api/tenants/string/users?limit=10&offset=0'
```

```ts
fetch('/api/tenants/string/users?limit=10&offset=0')
```

## GET /tenant-actions/me

`GET /tenant-actions/me`

Returns data for the current tenant

### Responses

#### `200`: Default Response

Body (`application/json`):

- `id` `string` _(required)_
- `name` `string` _(required)_
- `publicKey` `string` _(required)_
- `createdAt` `string <date-time>` _(required)_
- `updatedAt` `string <date-time>` _(required)_
- `defaultRoles` `object[]` _(required)_
  - `id` `string` _(required)_
  - `roleName` `string` _(required)_
  - `systemPermissions` `string[]`
  - `isSystemRole` `boolean`
  - `organizationId` `string | null`
  - `createdAt` `string <date-time>`
  - `updatedAt` `string <date-time>`

#### `401`: Default Response

Body (`application/json`):

- `error` `object` _(required)_
  - `code` `string` _(required)_
  - `message` `string` _(required)_
  - `issues` `unknown[]`

#### `403`: Default Response

Body (`application/json`):

- `error` `object` _(required)_
  - `code` `string` _(required)_
  - `message` `string` _(required)_
  - `issues` `unknown[]`

### Example request

```bash
curl /api/tenant-actions/me
```

```ts
fetch('/api/tenant-actions/me')
```

## GET /tenant-actions/users

`GET /tenant-actions/users`

Returns the list of users associated with current tenant

### Query parameters

- `limit` `integer`
- `offset` `integer`

### Responses

#### `200`: Default Response

Body (`application/json`):

- `items` `object[]` _(required)_
  - `id` `string` _(required)_
  - `walletAddresses` `object[]` _(required)_
    - `walletAddress` `string` _(required)_
  - `displayName` `string` _(required)_
- `pagination` `object` _(required)_
  - `currentPage` `number` _(required)_
  - `totalPages` `number` _(required)_
  - `totalItems` `number` _(required)_
  - `limit` `number` _(required)_
  - `offset` `number` _(required)_

#### `400`: Default Response

Body (`application/json`):

- `error` `object` _(required)_
  - `code` `string` _(required)_
  - `message` `string` _(required)_
  - `issues` `unknown[]`

#### `401`: Default Response

Body (`application/json`):

- `error` `object` _(required)_
  - `code` `string` _(required)_
  - `message` `string` _(required)_
  - `issues` `unknown[]`

#### `404`: Default Response

Body (`application/json`):

- `error` `object` _(required)_
  - `code` `string` _(required)_
  - `message` `string` _(required)_
  - `issues` `unknown[]`

### Example request

```bash
curl '/api/tenant-actions/users?limit=10&offset=0'
```

```ts
fetch('/api/tenant-actions/users?limit=10&offset=0')
```

## POST /tenant-actions/users

`POST /tenant-actions/users`

Creates a user associated with the current tenant

### Request body (required) (`application/json`)

- `walletAddresses` `object[]` _(required)_
  - `walletAddress` `string` _(required)_
- `displayName` `string` _(required)_

### Responses

#### `200`: Default Response

Body (`application/json`):

- `id` `string` _(required)_
- `walletAddresses` `object[]` _(required)_
  - `walletAddress` `string` _(required)_
- `displayName` `string` _(required)_

#### `400`: Default Response

Body (`application/json`):

- `error` `object` _(required)_
  - `code` `string` _(required)_
  - `message` `string` _(required)_
  - `issues` `unknown[]`

#### `401`: Default Response

Body (`application/json`):

- `error` `object` _(required)_
  - `code` `string` _(required)_
  - `message` `string` _(required)_
  - `issues` `unknown[]`

#### `403`: Default Response

Body (`application/json`):

- `error` `object` _(required)_
  - `code` `string` _(required)_
  - `message` `string` _(required)_
  - `issues` `unknown[]`

#### `409`: Default Response

Body (`application/json`):

- `error` `object` _(required)_
  - `code` `string` _(required)_
  - `message` `string` _(required)_
  - `issues` `unknown[]`

### Example request

```bash
curl /api/tenant-actions/users \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "walletAddresses": [
    {
      "walletAddress": "string"
    }
  ],
  "displayName": "string"
}'
```

```ts
fetch('/api/tenant-actions/users', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    walletAddresses: [
      {
        walletAddress: 'string'
      }
    ],
    displayName: 'string'
  })
})
```