> **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.

# services

## GET /admin/services/

`GET /admin/services/`

List services 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)_
  - `description` `string | null` _(required)_
  - `createdAt` `string <date-time>` _(required)_
  - `updatedAt` `string <date-time>` _(required)_
- `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/admin/services/?limit=10&offset=0'
```

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

## POST /admin/services/

`POST /admin/services/`

Creates a new service

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

- `name` `string` _(required)_
- `publicKey` `string` _(required)_
- `description` `string | null`

### Responses

#### `200`: Default Response

Body (`application/json`):

- `id` `string` _(required)_
- `name` `string` _(required)_
- `publicKey` `string` _(required)_
- `description` `string | null` _(required)_
- `createdAt` `string <date-time>` _(required)_
- `updatedAt` `string <date-time>` _(required)_

#### `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/admin/services/ \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "string",
  "publicKey": "string",
  "description": "string"
}'
```

```ts
fetch('/api/admin/services/', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'string',
    publicKey: 'string',
    description: 'string'
  })
})
```

## GET /admin/services/{id}

`GET /admin/services/{id}`

Get service by id

### Path parameters

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

### Responses

#### `200`: Default Response

Body (`application/json`):

- `id` `string` _(required)_
- `name` `string` _(required)_
- `publicKey` `string` _(required)_
- `description` `string | null` _(required)_
- `createdAt` `string <date-time>` _(required)_
- `updatedAt` `string <date-time>` _(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[]`

#### `404`: Default Response

Body (`application/json`):

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

### Example request

```bash
curl /api/admin/services/string
```

```ts
fetch('/api/admin/services/string')
```

## PUT /admin/services/{id}

`PUT /admin/services/{id}`

Update a service by id

### Path parameters

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

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

- `name` `string` _(required)_
- `publicKey` `string` _(required)_
- `description` `string | null` _(required)_

### Responses

#### `200`: Default Response

Body (`application/json`):

- `id` `string` _(required)_
- `name` `string` _(required)_
- `publicKey` `string` _(required)_
- `description` `string | null` _(required)_
- `createdAt` `string <date-time>` _(required)_
- `updatedAt` `string <date-time>` _(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/admin/services/string \
  --request PUT \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "string",
  "publicKey": "string",
  "description": "string"
}'
```

```ts
fetch('/api/admin/services/string', {
  method: 'PUT',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'string',
    publicKey: 'string',
    description: 'string'
  })
})
```

## DELETE /admin/services/{id}

`DELETE /admin/services/{id}`

Delete a service 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/admin/services/string \
  --request DELETE
```

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

## GET /service-actions/contracts/{contractAddress}

`GET /service-actions/contracts/{contractAddress}`

Get a contract by address for service integrations

### Path parameters

- `contractAddress` `string` _(required)_

### Responses

#### `200`: Default Response

Body (`application/json`):

- `contractAddress` `string` _(required)_
- `abi` `string` _(required)_
- `name` `string` _(required)_
- `description` `string | null` _(required)_
- `discloseErc20TotalSupply` `boolean` _(required)_
- `discloseBytecode` `boolean` _(required)_
- `templateId` `integer` _(required)_
- `isSystemContract` `boolean` _(required)_
- `organizationId` `string | null` _(required)_
- `disclosedAddresses` `object[]` _(required)_
  - `address` `string` _(required)_
- `createdAt` `string <date-time>` _(required)_
- `updatedAt` `string <date-time>` _(required)_
- `disclosureStartBlock` `string` _(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[]`

#### `404`: Default Response

Body (`application/json`):

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

### Example request

```bash
curl /api/service-actions/contracts/string
```

```ts
fetch('/api/service-actions/contracts/string')
```