---
title: "List the professionals of a service"
description: "The professionals who attend one service at one of the clinic's cost centres, in ascending id order, as SIIPS's directory lists them. Cached for one hour; refresh reads SIIPS again.\n\n- **Scopes:** any one of `visoft:appointments:read`, `visoft:appointments:write`\n- **Credentials:** an API key, a client-credentials token or a person's access token\n- **Effect:** read-only; safe to retry\n- **Limits:** response up to 1 MB\n- **CLI:** `arbol visoft professionals list` · **MCP tool:** `visoft_professionals_list`"
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.getarbol.com/llms.txt
> Use this file to discover all available pages before exploring further.

Path: Visoft API › Professionals

`GET /v1/visoft/professionals`

The professionals who attend one service at one of the clinic's cost centres, in ascending id order, as SIIPS's directory lists them. Cached for one hour; refresh reads SIIPS again.

- **Scopes:** any one of `visoft:appointments:read`, `visoft:appointments:write`
- **Credentials:** an API key, a client-credentials token or a person's access token
- **Effect:** read-only; safe to retry
- **Limits:** response up to 1 MB
- **CLI:** `arbol visoft professionals list` · **MCP tool:** `visoft_professionals_list`

## Authentication

Requires one of the following:

- `arbolHuman`, oauth2, scopes: `visoft:appointments:read`
- `arbolHuman`, oauth2, scopes: `visoft:appointments:write`
- `arbolMachine`, oauth2, scopes: `visoft:appointments:read`
- `arbolMachine`, oauth2, scopes: `visoft:appointments:write`
- `arbolApiKey`, http, header `Authorization`

## Query parameters

- `serviceCode` (`visoft.professionals.list.query.serviceCode`; string, required) — The service, by the code a contract's services answer ("CUPS-890208").
  - minLength 3; maxLength 60; pattern `^[A-Za-z0-9]+-[A-Za-z0-9._-]+$`
- `cursor` (`visoft.professionals.list.query.cursor`; string, optional) — Opaque cursor returned by pageInfo; omit it to request the first page.
- `direction` (`visoft.professionals.list.query.direction`; string, optional) — Direction to traverse the stable keyset ordering from the supplied cursor.
  - one of `"forward"`, `"backward"`; default `"forward"`
- `limit` (`visoft.professionals.list.query.limit`; integer, optional) — Maximum items returned in one page. Defaults to 25; larger reads require another cursor.
  - min 1; max 100; default `25`
- `connectionId` (`visoft.professionals.list.query.connectionId`; string, optional) — The connection to run on. Optional when the organization has one Visoft connection; required when it has several. Another organization's connection is CONNECTION_NOT_FOUND.
  - minLength 5; maxLength 68; pattern `^con_[0-9A-Za-z]+$`
- `agencyCode` (`visoft.professionals.list.query.agencyCode`; string, optional) — One of the clinic's cost centres, as visoft.clinic.get lists them. Optional when the clinic has a default one.
  - pattern `^\d{3}$`
- `refresh` (`visoft.professionals.list.query.refresh`; boolean, optional) — Read SIIPS again instead of the connection's cache (contracts 12 h, services 6 h, professionals 1 h, a patient 5 min).

## Code samples

### cURL

```bash
curl "https://api.getarbol.com/v1/visoft/professionals?serviceCode=<serviceCode>" \
  --header "Authorization: Bearer $ARBOL_API_KEY"
```

### TypeScript

```typescript
import { createClient } from "@arbol-ai/sdk";

const arbol = createClient({
  baseUrl: "https://api.getarbol.com",
  token: process.env.ARBOL_API_KEY!,
});

const { data } = await arbol.visoft.professionals.list({
  serviceCode: "<serviceCode>",
});
```

### Rust

```rust
use arbol_sdk::{types, Client, Credential};

let arbol = Client::new(Credential::ApiKey(std::env::var("ARBOL_API_KEY")?))?;

let data = arbol
    .visoft()
    .professionals()
    .list(&types::VisoftProfessionalsListInput {
        service_code: "<serviceCode>".into(),
        cursor: None,
        direction: None,
        limit: None,
        connection_id: None,
        agency_code: None,
        refresh: None,
    })
    .await?;
```

### CLI

```bash
arbol visoft professionals list --service-code '<serviceCode>'
```

### MCP

```json
{
  "name": "visoft_professionals_list",
  "arguments": {
    "serviceCode": "<serviceCode>"
  }
}
```

## Responses

### 200

Successful operation.

#### Example

```json
{
  "success": true,
  "data": {
    "data": [
      {
        "id": "string",
        "name": "string",
        "label": "string",
        "specialty": "string"
      }
    ],
    "object": "list",
    "pageInfo": {
      "hasNextPage": true,
      "hasPreviousPage": true,
      "nextCursor": "string",
      "previousCursor": "string"
    }
  },
  "error": null,
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`visoft.professionals.list.response.200.success`; boolean, required)
  - one of `true`
- `data` (`visoft.professionals.list.response.200.data`; object, required)
  - `data` (`visoft.professionals.list.response.200.data.data`; array<object>, required) — Items admitted by this resource contract within the verified organization.
    - `id` (`visoft.professionals.list.response.200.data.data.id`; string, required) — The professional's SIIPS id. Empty only in an availability answer of an agenda SIIPS lists without its professionals.
    - `name` (`visoft.professionals.list.response.200.data.data.name`; string, required) — Their name, without the specialty SIIPS appends.
    - `label` (`visoft.professionals.list.response.200.data.data.label`; string, required) — Their name as SIIPS labels it.
    - `specialty` (`visoft.professionals.list.response.200.data.data.specialty`; string, required) — The specialty SIIPS appends to the label; empty when none.
  - `object` (`visoft.professionals.list.response.200.data.object`; string, required) — Discriminator for a resource list response.
  - `pageInfo` (`visoft.professionals.list.response.200.data.pageInfo`; object, required) — Opaque navigation cursors for this page’s stable keyset order.
    - `hasNextPage` (`visoft.professionals.list.response.200.data.pageInfo.hasNextPage`; boolean, required) — Whether a later page exists in the current ordering.
    - `hasPreviousPage` (`visoft.professionals.list.response.200.data.pageInfo.hasPreviousPage`; boolean, required) — Whether an earlier page exists in the current ordering.
    - `nextCursor` (`visoft.professionals.list.response.200.data.pageInfo.nextCursor`; string | null, required) — Opaque cursor for the next page, or null when there is none.
    - `previousCursor` (`visoft.professionals.list.response.200.data.pageInfo.previousCursor`; string | null, required) — Opaque cursor for the previous page, or null when there is none.
- `error` (`visoft.professionals.list.response.200.error`; unknown, required)
- `metadata` (`visoft.professionals.list.response.200.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`visoft.professionals.list.response.200.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 400

`INVALID_INPUT`: The request does not match the published schema.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "INVALID_INPUT",
    "message": "string",
    "retryable": false,
    "data": {
      "issues": [
        {
          "path": "string",
          "message": "string"
        }
      ]
    }
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`visoft.professionals.list.response.400.success`; boolean, required)
  - one of `false`
- `data` (`visoft.professionals.list.response.400.data`; unknown, required)
- `error` (`visoft.professionals.list.response.400.error`; object, required) — The request does not match the published schema.
  - `code` (`visoft.professionals.list.response.400.error.code`; string, required) — The failure code, stable across releases.
    - one of `"INVALID_INPUT"`
  - `message` (`visoft.professionals.list.response.400.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`visoft.professionals.list.response.400.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`visoft.professionals.list.response.400.error.data`; object, required)
    - `issues` (`visoft.professionals.list.response.400.error.data.issues`; array<object>, optional)
      - `path` (`visoft.professionals.list.response.400.error.data.issues.path`; string, required) — RFC 6901 JSON Pointer to the refused field; empty for the whole input.
        - maxLength 256
      - `message` (`visoft.professionals.list.response.400.error.data.issues.message`; string, required)
        - maxLength 256
- `metadata` (`visoft.professionals.list.response.400.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`visoft.professionals.list.response.400.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 401

`UNAUTHORIZED`: A valid access token is required.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "string",
    "retryable": false,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`visoft.professionals.list.response.401.success`; boolean, required)
  - one of `false`
- `data` (`visoft.professionals.list.response.401.data`; unknown, required)
- `error` (`visoft.professionals.list.response.401.error`; object, required) — A valid access token is required.
  - `code` (`visoft.professionals.list.response.401.error.code`; string, required) — The failure code, stable across releases.
    - one of `"UNAUTHORIZED"`
  - `message` (`visoft.professionals.list.response.401.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`visoft.professionals.list.response.401.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`visoft.professionals.list.response.401.error.data`; object, required) — No fields.
- `metadata` (`visoft.professionals.list.response.401.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`visoft.professionals.list.response.401.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 403

`FORBIDDEN`: The token does not authorize this operation.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "FORBIDDEN",
    "message": "string",
    "retryable": false,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`visoft.professionals.list.response.403.success`; boolean, required)
  - one of `false`
- `data` (`visoft.professionals.list.response.403.data`; unknown, required)
- `error` (`visoft.professionals.list.response.403.error`; object, required) — The token does not authorize this operation.
  - `code` (`visoft.professionals.list.response.403.error.code`; string, required) — The failure code, stable across releases.
    - one of `"FORBIDDEN"`
  - `message` (`visoft.professionals.list.response.403.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`visoft.professionals.list.response.403.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`visoft.professionals.list.response.403.error.data`; object, required) — No fields.
- `metadata` (`visoft.professionals.list.response.403.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`visoft.professionals.list.response.403.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 404

`CONNECTION_NOT_FOUND`: The organization has no such connection.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "CONNECTION_NOT_FOUND",
    "message": "string",
    "retryable": false,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`visoft.professionals.list.response.404.success`; boolean, required)
  - one of `false`
- `data` (`visoft.professionals.list.response.404.data`; unknown, required)
- `error` (`visoft.professionals.list.response.404.error`; object, required) — The organization has no such connection.
  - `code` (`visoft.professionals.list.response.404.error.code`; string, required) — The failure code, stable across releases.
    - one of `"CONNECTION_NOT_FOUND"`
  - `message` (`visoft.professionals.list.response.404.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`visoft.professionals.list.response.404.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`visoft.professionals.list.response.404.error.data`; object, required) — No fields.
- `metadata` (`visoft.professionals.list.response.404.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`visoft.professionals.list.response.404.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 409

`CONNECTION_NOT_CONFIGURED`: The organization has no active Visoft connection for this call; an administrator connects Visoft in Account.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "CONNECTION_NOT_CONFIGURED",
    "message": "string",
    "retryable": false,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`visoft.professionals.list.response.409.success`; boolean, required)
  - one of `false`
- `data` (`visoft.professionals.list.response.409.data`; unknown, required)
- `error` (`visoft.professionals.list.response.409.error`; object, required) — The organization has no active Visoft connection for this call; an administrator connects Visoft in Account.
  - `code` (`visoft.professionals.list.response.409.error.code`; string, required) — The failure code, stable across releases.
    - one of `"CONNECTION_NOT_CONFIGURED"`
  - `message` (`visoft.professionals.list.response.409.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`visoft.professionals.list.response.409.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`visoft.professionals.list.response.409.error.data`; object, required) — No fields.
- `metadata` (`visoft.professionals.list.response.409.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`visoft.professionals.list.response.409.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 422

- `CREDENTIALS_REJECTED`: The organization's connection to this integration couldn't complete the request. Don't retry it automatically; if it keeps happening, contact your Arbol team.
- `AGENCY_NOT_SERVED`: The cost centre is not one of the connection's clinic: use one visoft.clinic.get lists.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "CREDENTIALS_REJECTED",
    "message": "string",
    "retryable": false
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`visoft.professionals.list.response.422.success`; boolean, required)
  - one of `false`
- `data` (`visoft.professionals.list.response.422.data`; unknown, required)
- `error` (`visoft.professionals.list.response.422.error`; one of, required)
  - one of: `VisoftCredentialsRejectedFailure`, `VisoftAgencyNotServedFailure`
  - discriminator: `code`
- `metadata` (`visoft.professionals.list.response.422.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`visoft.professionals.list.response.422.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 429

`RATE_LIMITED`: The request rate limit was exceeded. Try again later.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "RATE_LIMITED",
    "message": "string",
    "retryable": true,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`visoft.professionals.list.response.429.success`; boolean, required)
  - one of `false`
- `data` (`visoft.professionals.list.response.429.data`; unknown, required)
- `error` (`visoft.professionals.list.response.429.error`; object, required) — The request rate limit was exceeded. Try again later.
  - `code` (`visoft.professionals.list.response.429.error.code`; string, required) — The failure code, stable across releases.
    - one of `"RATE_LIMITED"`
  - `message` (`visoft.professionals.list.response.429.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`visoft.professionals.list.response.429.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `true`
  - `data` (`visoft.professionals.list.response.429.error.data`; object, required) — No fields.
- `metadata` (`visoft.professionals.list.response.429.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`visoft.professionals.list.response.429.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 500

`INTERNAL_ERROR`: The service could not complete the operation.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "string",
    "retryable": false,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`visoft.professionals.list.response.500.success`; boolean, required)
  - one of `false`
- `data` (`visoft.professionals.list.response.500.data`; unknown, required)
- `error` (`visoft.professionals.list.response.500.error`; object, required) — The service could not complete the operation.
  - `code` (`visoft.professionals.list.response.500.error.code`; string, required) — The failure code, stable across releases.
    - one of `"INTERNAL_ERROR"`
  - `message` (`visoft.professionals.list.response.500.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`visoft.professionals.list.response.500.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`visoft.professionals.list.response.500.error.data`; object, required) — No fields.
- `metadata` (`visoft.professionals.list.response.500.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`visoft.professionals.list.response.500.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 502

- `OUTCOME_UNKNOWN`: The operation may have been applied; check its result before repeating it.
- `PROVIDER_UNAVAILABLE`: The clinical system did not answer or could not complete the request.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "OUTCOME_UNKNOWN",
    "message": "string",
    "retryable": false,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`visoft.professionals.list.response.502.success`; boolean, required)
  - one of `false`
- `data` (`visoft.professionals.list.response.502.data`; unknown, required)
- `error` (`visoft.professionals.list.response.502.error`; one of, required)
  - one of: `OutcomeUnknownFailure`, `VisoftProviderUnavailableFailure`
  - discriminator: `code`
- `metadata` (`visoft.professionals.list.response.502.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`visoft.professionals.list.response.502.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 503

`UPSTREAM_UNAVAILABLE`: The upstream service could not complete the request.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "UPSTREAM_UNAVAILABLE",
    "message": "string",
    "retryable": true,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`visoft.professionals.list.response.503.success`; boolean, required)
  - one of `false`
- `data` (`visoft.professionals.list.response.503.data`; unknown, required)
- `error` (`visoft.professionals.list.response.503.error`; object, required) — The upstream service could not complete the request.
  - `code` (`visoft.professionals.list.response.503.error.code`; string, required) — The failure code, stable across releases.
    - one of `"UPSTREAM_UNAVAILABLE"`
  - `message` (`visoft.professionals.list.response.503.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`visoft.professionals.list.response.503.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `true`
  - `data` (`visoft.professionals.list.response.503.error.data`; object, required) — No fields.
- `metadata` (`visoft.professionals.list.response.503.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`visoft.professionals.list.response.503.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 504

`UPSTREAM_TIMEOUT`: The upstream service did not respond before its deadline.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "UPSTREAM_TIMEOUT",
    "message": "string",
    "retryable": true,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`visoft.professionals.list.response.504.success`; boolean, required)
  - one of `false`
- `data` (`visoft.professionals.list.response.504.data`; unknown, required)
- `error` (`visoft.professionals.list.response.504.error`; object, required) — The upstream service did not respond before its deadline.
  - `code` (`visoft.professionals.list.response.504.error.code`; string, required) — The failure code, stable across releases.
    - one of `"UPSTREAM_TIMEOUT"`
  - `message` (`visoft.professionals.list.response.504.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`visoft.professionals.list.response.504.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `true`
  - `data` (`visoft.professionals.list.response.504.error.data`; object, required) — No fields.
- `metadata` (`visoft.professionals.list.response.504.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`visoft.professionals.list.response.504.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.


Source: https://docs.getarbol.com/api/visoft/professionals/list/index.md