---
title: "List appointments"
description: "Use the organization gMedic account. Read-only request; provider failures are never empty results.\n\n- **Scope:** `gmedic:appointments:read`\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 256 KB\n- **CLI:** `arbol gmedic appointments list` · **MCP tool:** `gmedic_appointments_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: gMedic API › Appointments

`GET /v1/gmedic/appointments`

Use the organization gMedic account. Read-only request; provider failures are never empty results.

- **Scope:** `gmedic:appointments:read`
- **Credentials:** an API key, a client-credentials token or a person's access token
- **Effect:** read-only; safe to retry
- **Limits:** response up to 256 KB
- **CLI:** `arbol gmedic appointments list` · **MCP tool:** `gmedic_appointments_list`

## Authentication

Requires one of the following:

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

## Query parameters

- `cursor` (`gmedic.appointments.list.query.cursor`; string, optional) — Opaque cursor returned by pageInfo; omit it to request the first page.
- `direction` (`gmedic.appointments.list.query.direction`; string, optional) — Direction to traverse the stable keyset ordering from the supplied cursor.
  - one of `"forward"`, `"backward"`; default `"forward"`
- `limit` (`gmedic.appointments.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`
- `agendaId` (`gmedic.appointments.list.query.agendaId`; string, optional) — The agenda id.
  - pattern `^[1-9][0-9]{0,14}$`
- `date` (`gmedic.appointments.list.query.date`; string, optional) — The date.
  - maxLength 20000
- `appointmentId` (`gmedic.appointments.list.query.appointmentId`; string, optional) — The appointment id.
  - pattern `^[1-9][0-9]{0,14}$`
- `patientId` (`gmedic.appointments.list.query.patientId`; string, optional) — The patient id.
  - pattern `^[1-9][0-9]{0,14}$`
- `pending` (`gmedic.appointments.list.query.pending`; boolean, optional) — The pending.
- `connectionId` (`gmedic.appointments.list.query.connectionId`; string, optional) — The connection id.
  - pattern `^con_[0-9A-Za-z]{26}$`
- `id` (`gmedic.appointments.list.query.id`; string, optional) — Deprecated: use `appointmentId`. Answered until 2027-01-28.
  - pattern `^[1-9][0-9]{0,14}$`

## Code samples

### cURL

```bash
curl https://api.getarbol.com/v1/gmedic/appointments \
  --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.gmedic.appointments.list();
```

### Rust

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

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

let data = arbol
    .gmedic()
    .appointments()
    .list(&types::GmedicAppointmentsListInput::default())
    .await?;
```

### CLI

```bash
arbol gmedic appointments list
```

### MCP

```json
{
  "name": "gmedic_appointments_list",
  "arguments": {}
}
```

## Responses

### 200

Successful operation.

#### Example

```json
{
  "success": true,
  "data": {
    "data": [
      {
        "id": "string",
        "key": "string",
        "createdAt": "string",
        "creationDate": "string",
        "updatedAt": "string",
        "modificationDate": "string",
        "title": "string",
        "description": "string",
        "allDay": true,
        "block": true,
        "readOnly": true,
        "startsAt": "2019-08-24T14:15:22Z",
        "endsAt": "2019-08-24T14:15:22Z",
        "startDate": "string",
        "endDate": "string",
        "desiredDate": "string",
        "opportunityIndicator": -2147483648,
        "mainAttendantId": "string",
        "mainAttendantName": "string",
        "mainAttendantIdentification": "string",
        "mainAttendantDocumentType": {
          "id": "string",
          "name": "string",
          "label": "string",
          "value": "string"
        },
        "mainAttendantPhone": "string",
        "mainAttendantMobile": "string",
        "mainAttendantEmail": "string",
        "appointmentColor": {
          "id": "string",
          "name": "string",
          "label": "string",
          "value": "string"
        },
        "status": {
          "id": "string",
          "name": "string",
          "label": "string",
          "value": "string"
        },
        "state": {
          "id": "string",
          "name": "string",
          "label": "string",
          "value": "string"
        },
        "rejectReason": {
          "id": "string",
          "name": "string",
          "label": "string",
          "value": "string"
        },
        "modality": "FACE_TO_FACE",
        "videocallProvider": "string",
        "meetURL": "string",
        "agendaId": "string",
        "agendaName": "string",
        "selfServiceAllowCancel": true,
        "selfServiceAllowReschedule": true,
        "branchOffice": "string",
        "location": "string",
        "service": "string",
        "serviceId": "string",
        "authorization": "string",
        "medicalAuthorizationId": "string",
        "authorizationSessions": 0,
        "currentSessions": "string",
        "entidad": "string",
        "invoice": "string",
        "userType": "string",
        "cupCode": "string",
        "cupName": "string",
        "mainDiagnosticCode": "string",
        "mainDiagnosticName": "string",
        "consultationPurposeId": "string",
        "consultationPurposeCode": "string",
        "consultationPurposeName": "string",
        "externalCauseId": "string",
        "externalCauseCode": "string",
        "externalCauseName": "string",
        "medicalServiceId": "string",
        "medicalServiceCode": "string",
        "medicalServiceName": "string",
        "servicesGroupId": "string",
        "servicesGroupCode": "string",
        "servicesGroupName": "string",
        "serviceModalityId": "string",
        "serviceModalityCode": "string",
        "serviceModalityName": "string",
        "viaEntryId": "string",
        "viaEntryCode": "string",
        "viaEntryName": "string",
        "userObjectId": "string",
        "personCreator": "string",
        "date": "string",
        "time": "string"
      }
    ],
    "object": "list",
    "pageInfo": {
      "hasNextPage": true,
      "hasPreviousPage": true,
      "nextCursor": "string",
      "previousCursor": "string"
    }
  },
  "error": null,
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`gmedic.appointments.list.response.200.success`; boolean, required)
  - one of `true`
- `data` (`gmedic.appointments.list.response.200.data`; object, required)
  - `data` (`gmedic.appointments.list.response.200.data.data`; array<object>, required) — Items admitted by this resource contract within the verified organization.
    - `id` (`gmedic.appointments.list.response.200.data.data.id`; string, required)
      - pattern `^[1-9][0-9]{0,14}$`
    - `key` (`gmedic.appointments.list.response.200.data.data.key`; string | null, optional)
      - maxLength 20000
    - `createdAt` (`gmedic.appointments.list.response.200.data.data.createdAt`; string | null, optional)
      - maxLength 20000
    - `creationDate` (`gmedic.appointments.list.response.200.data.data.creationDate`; string | null, optional, deprecated) — Deprecated: use `createdAt`. Answered until 2027-01-28.
      - maxLength 20000
    - `updatedAt` (`gmedic.appointments.list.response.200.data.data.updatedAt`; string | null, optional)
      - maxLength 20000
    - `modificationDate` (`gmedic.appointments.list.response.200.data.data.modificationDate`; string | null, optional, deprecated) — Deprecated: use `updatedAt`. Answered until 2027-01-28.
      - maxLength 20000
    - `title` (`gmedic.appointments.list.response.200.data.data.title`; string | null, optional)
      - maxLength 20000
    - `description` (`gmedic.appointments.list.response.200.data.data.description`; string | null, optional)
      - maxLength 20000
    - `allDay` (`gmedic.appointments.list.response.200.data.data.allDay`; boolean | null, optional)
    - `block` (`gmedic.appointments.list.response.200.data.data.block`; boolean | null, optional)
    - `readOnly` (`gmedic.appointments.list.response.200.data.data.readOnly`; boolean | null, optional)
    - `startsAt` (`gmedic.appointments.list.response.200.data.data.startsAt`; string | null, optional)
      - format `date-time`
    - `endsAt` (`gmedic.appointments.list.response.200.data.data.endsAt`; string | null, optional)
      - format `date-time`
    - `startDate` (`gmedic.appointments.list.response.200.data.data.startDate`; string | null, optional, deprecated) — Deprecated: use `startsAt`. Answered until 2027-01-28.
      - maxLength 20000
    - `endDate` (`gmedic.appointments.list.response.200.data.data.endDate`; string | null, optional, deprecated) — Deprecated: use `endsAt`. Answered until 2027-01-28.
      - maxLength 20000
    - `desiredDate` (`gmedic.appointments.list.response.200.data.data.desiredDate`; string | null, optional)
      - maxLength 20000
    - `opportunityIndicator` (`gmedic.appointments.list.response.200.data.data.opportunityIndicator`; integer | null, optional)
      - min -2147483648; max 2147483647
    - `mainAttendantId` (`gmedic.appointments.list.response.200.data.data.mainAttendantId`; string | null, optional)
      - pattern `^[1-9][0-9]{0,14}$`
    - `mainAttendantName` (`gmedic.appointments.list.response.200.data.data.mainAttendantName`; string | null, optional)
      - maxLength 20000
    - `mainAttendantIdentification` (`gmedic.appointments.list.response.200.data.data.mainAttendantIdentification`; string | null, optional)
      - maxLength 20000
    - `mainAttendantDocumentType` (`gmedic.appointments.list.response.200.data.data.mainAttendantDocumentType`; object | null, optional)
      - `id` (`gmedic.appointments.list.response.200.data.data.mainAttendantDocumentType.id`; string, required)
        - pattern `^[1-9][0-9]{0,14}$`
      - `name` (`gmedic.appointments.list.response.200.data.data.mainAttendantDocumentType.name`; string | null, optional)
        - maxLength 20000
      - `label` (`gmedic.appointments.list.response.200.data.data.mainAttendantDocumentType.label`; string | null, optional)
        - maxLength 20000
      - `value` (`gmedic.appointments.list.response.200.data.data.mainAttendantDocumentType.value`; string | null, optional)
        - maxLength 20000
    - `mainAttendantPhone` (`gmedic.appointments.list.response.200.data.data.mainAttendantPhone`; string | null, optional)
      - maxLength 20000
    - `mainAttendantMobile` (`gmedic.appointments.list.response.200.data.data.mainAttendantMobile`; string | null, optional)
      - maxLength 20000
    - `mainAttendantEmail` (`gmedic.appointments.list.response.200.data.data.mainAttendantEmail`; string | null, optional)
      - maxLength 20000
    - `appointmentColor` (`gmedic.appointments.list.response.200.data.data.appointmentColor`; object | null, optional)
      - `id` (`gmedic.appointments.list.response.200.data.data.appointmentColor.id`; string, required)
        - pattern `^[1-9][0-9]{0,14}$`
      - `name` (`gmedic.appointments.list.response.200.data.data.appointmentColor.name`; string | null, optional)
        - maxLength 20000
      - `label` (`gmedic.appointments.list.response.200.data.data.appointmentColor.label`; string | null, optional)
        - maxLength 20000
      - `value` (`gmedic.appointments.list.response.200.data.data.appointmentColor.value`; string | null, optional)
        - maxLength 20000
    - `status` (`gmedic.appointments.list.response.200.data.data.status`; object | null, optional)
      - `id` (`gmedic.appointments.list.response.200.data.data.status.id`; string, required)
        - pattern `^[1-9][0-9]{0,14}$`
      - `name` (`gmedic.appointments.list.response.200.data.data.status.name`; string | null, optional)
        - maxLength 20000
      - `label` (`gmedic.appointments.list.response.200.data.data.status.label`; string | null, optional)
        - maxLength 20000
      - `value` (`gmedic.appointments.list.response.200.data.data.status.value`; string | null, optional)
        - maxLength 20000
    - `state` (`gmedic.appointments.list.response.200.data.data.state`; object | null, optional, deprecated) — Deprecated: use `status`. Answered until 2027-01-28.
      - `id` (`gmedic.appointments.list.response.200.data.data.state.id`; string, required)
        - pattern `^[1-9][0-9]{0,14}$`
      - `name` (`gmedic.appointments.list.response.200.data.data.state.name`; string | null, optional)
        - maxLength 20000
      - `label` (`gmedic.appointments.list.response.200.data.data.state.label`; string | null, optional)
        - maxLength 20000
      - `value` (`gmedic.appointments.list.response.200.data.data.state.value`; string | null, optional)
        - maxLength 20000
    - `rejectReason` (`gmedic.appointments.list.response.200.data.data.rejectReason`; object | null, optional)
      - `id` (`gmedic.appointments.list.response.200.data.data.rejectReason.id`; string, required)
        - pattern `^[1-9][0-9]{0,14}$`
      - `name` (`gmedic.appointments.list.response.200.data.data.rejectReason.name`; string | null, optional)
        - maxLength 20000
      - `label` (`gmedic.appointments.list.response.200.data.data.rejectReason.label`; string | null, optional)
        - maxLength 20000
      - `value` (`gmedic.appointments.list.response.200.data.data.rejectReason.value`; string | null, optional)
        - maxLength 20000
    - `modality` (`gmedic.appointments.list.response.200.data.data.modality`; string | null, optional)
      - one of `"FACE_TO_FACE"`, `"VIRTUAL"`, `"HOME_VISIT"`, `"NOT_APPLICABLE"`, `null`
    - `videocallProvider` (`gmedic.appointments.list.response.200.data.data.videocallProvider`; string | null, optional)
      - maxLength 20000
    - `meetURL` (`gmedic.appointments.list.response.200.data.data.meetURL`; string | null, optional)
      - maxLength 20000
    - `agendaId` (`gmedic.appointments.list.response.200.data.data.agendaId`; string | null, optional)
      - pattern `^[1-9][0-9]{0,14}$`
    - `agendaName` (`gmedic.appointments.list.response.200.data.data.agendaName`; string | null, optional)
      - maxLength 20000
    - `selfServiceAllowCancel` (`gmedic.appointments.list.response.200.data.data.selfServiceAllowCancel`; boolean | null, optional)
    - `selfServiceAllowReschedule` (`gmedic.appointments.list.response.200.data.data.selfServiceAllowReschedule`; boolean | null, optional)
    - `branchOffice` (`gmedic.appointments.list.response.200.data.data.branchOffice`; string | null, optional)
      - maxLength 20000
    - `location` (`gmedic.appointments.list.response.200.data.data.location`; string | null, optional)
      - maxLength 20000
    - `service` (`gmedic.appointments.list.response.200.data.data.service`; string | null, optional)
      - maxLength 20000
    - `serviceId` (`gmedic.appointments.list.response.200.data.data.serviceId`; string | null, optional)
      - pattern `^[1-9][0-9]{0,14}$`
    - `authorization` (`gmedic.appointments.list.response.200.data.data.authorization`; string | null, optional)
      - maxLength 20000
    - `medicalAuthorizationId` (`gmedic.appointments.list.response.200.data.data.medicalAuthorizationId`; string | null, optional)
      - pattern `^[1-9][0-9]{0,14}$`
    - `authorizationSessions` (`gmedic.appointments.list.response.200.data.data.authorizationSessions`; integer | null, optional)
      - min 0; max 9007199254740991
    - `currentSessions` (`gmedic.appointments.list.response.200.data.data.currentSessions`; string | null, optional)
      - maxLength 20000
    - `entidad` (`gmedic.appointments.list.response.200.data.data.entidad`; string | null, optional)
      - maxLength 20000
    - `invoice` (`gmedic.appointments.list.response.200.data.data.invoice`; string | null, optional)
      - maxLength 20000
    - `userType` (`gmedic.appointments.list.response.200.data.data.userType`; string | null, optional)
      - maxLength 20000
    - `cupCode` (`gmedic.appointments.list.response.200.data.data.cupCode`; string | null, optional)
      - maxLength 20000
    - `cupName` (`gmedic.appointments.list.response.200.data.data.cupName`; string | null, optional)
      - maxLength 20000
    - `mainDiagnosticCode` (`gmedic.appointments.list.response.200.data.data.mainDiagnosticCode`; string | null, optional)
      - maxLength 20000
    - `mainDiagnosticName` (`gmedic.appointments.list.response.200.data.data.mainDiagnosticName`; string | null, optional)
      - maxLength 20000
    - `consultationPurposeId` (`gmedic.appointments.list.response.200.data.data.consultationPurposeId`; string | null, optional)
      - pattern `^[1-9][0-9]{0,14}$`
    - `consultationPurposeCode` (`gmedic.appointments.list.response.200.data.data.consultationPurposeCode`; string | null, optional)
      - maxLength 20000
    - `consultationPurposeName` (`gmedic.appointments.list.response.200.data.data.consultationPurposeName`; string | null, optional)
      - maxLength 20000
    - `externalCauseId` (`gmedic.appointments.list.response.200.data.data.externalCauseId`; string | null, optional)
      - pattern `^[1-9][0-9]{0,14}$`
    - `externalCauseCode` (`gmedic.appointments.list.response.200.data.data.externalCauseCode`; string | null, optional)
      - maxLength 20000
    - `externalCauseName` (`gmedic.appointments.list.response.200.data.data.externalCauseName`; string | null, optional)
      - maxLength 20000
    - `medicalServiceId` (`gmedic.appointments.list.response.200.data.data.medicalServiceId`; string | null, optional)
      - pattern `^[1-9][0-9]{0,14}$`
    - `medicalServiceCode` (`gmedic.appointments.list.response.200.data.data.medicalServiceCode`; string | null, optional)
      - maxLength 20000
    - `medicalServiceName` (`gmedic.appointments.list.response.200.data.data.medicalServiceName`; string | null, optional)
      - maxLength 20000
    - `servicesGroupId` (`gmedic.appointments.list.response.200.data.data.servicesGroupId`; string | null, optional)
      - pattern `^[1-9][0-9]{0,14}$`
    - `servicesGroupCode` (`gmedic.appointments.list.response.200.data.data.servicesGroupCode`; string | null, optional)
      - maxLength 20000
    - `servicesGroupName` (`gmedic.appointments.list.response.200.data.data.servicesGroupName`; string | null, optional)
      - maxLength 20000
    - `serviceModalityId` (`gmedic.appointments.list.response.200.data.data.serviceModalityId`; string | null, optional)
      - pattern `^[1-9][0-9]{0,14}$`
    - `serviceModalityCode` (`gmedic.appointments.list.response.200.data.data.serviceModalityCode`; string | null, optional)
      - maxLength 20000
    - `serviceModalityName` (`gmedic.appointments.list.response.200.data.data.serviceModalityName`; string | null, optional)
      - maxLength 20000
    - `viaEntryId` (`gmedic.appointments.list.response.200.data.data.viaEntryId`; string | null, optional)
      - pattern `^[1-9][0-9]{0,14}$`
    - `viaEntryCode` (`gmedic.appointments.list.response.200.data.data.viaEntryCode`; string | null, optional)
      - maxLength 20000
    - `viaEntryName` (`gmedic.appointments.list.response.200.data.data.viaEntryName`; string | null, optional)
      - maxLength 20000
    - `userObjectId` (`gmedic.appointments.list.response.200.data.data.userObjectId`; string | null, optional)
      - pattern `^[1-9][0-9]{0,14}$`
    - `personCreator` (`gmedic.appointments.list.response.200.data.data.personCreator`; string | null, optional)
      - maxLength 20000
    - `date` (`gmedic.appointments.list.response.200.data.data.date`; string | null, optional, deprecated) — Deprecated: use `startsAt`. Answered until 2027-01-28.
      - maxLength 20000
    - `time` (`gmedic.appointments.list.response.200.data.data.time`; string | null, optional, deprecated) — Deprecated: use `startsAt`. Answered until 2027-01-28.
      - maxLength 20000
  - `object` (`gmedic.appointments.list.response.200.data.object`; string, required) — Discriminator for a resource list response.
  - `pageInfo` (`gmedic.appointments.list.response.200.data.pageInfo`; object, required) — Opaque navigation cursors for this page’s stable keyset order.
    - `hasNextPage` (`gmedic.appointments.list.response.200.data.pageInfo.hasNextPage`; boolean, required) — Whether a later page exists in the current ordering.
    - `hasPreviousPage` (`gmedic.appointments.list.response.200.data.pageInfo.hasPreviousPage`; boolean, required) — Whether an earlier page exists in the current ordering.
    - `nextCursor` (`gmedic.appointments.list.response.200.data.pageInfo.nextCursor`; string | null, required) — Opaque cursor for the next page, or null when there is none.
    - `previousCursor` (`gmedic.appointments.list.response.200.data.pageInfo.previousCursor`; string | null, required) — Opaque cursor for the previous page, or null when there is none.
- `error` (`gmedic.appointments.list.response.200.error`; unknown, required)
- `metadata` (`gmedic.appointments.list.response.200.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`gmedic.appointments.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` (`gmedic.appointments.list.response.400.success`; boolean, required)
  - one of `false`
- `data` (`gmedic.appointments.list.response.400.data`; unknown, required)
- `error` (`gmedic.appointments.list.response.400.error`; object, required) — The request does not match the published schema.
  - `code` (`gmedic.appointments.list.response.400.error.code`; string, required) — The failure code, stable across releases.
    - one of `"INVALID_INPUT"`
  - `message` (`gmedic.appointments.list.response.400.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`gmedic.appointments.list.response.400.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`gmedic.appointments.list.response.400.error.data`; object, required)
    - `issues` (`gmedic.appointments.list.response.400.error.data.issues`; array<object>, optional)
      - `path` (`gmedic.appointments.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` (`gmedic.appointments.list.response.400.error.data.issues.message`; string, required)
        - maxLength 256
- `metadata` (`gmedic.appointments.list.response.400.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`gmedic.appointments.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` (`gmedic.appointments.list.response.401.success`; boolean, required)
  - one of `false`
- `data` (`gmedic.appointments.list.response.401.data`; unknown, required)
- `error` (`gmedic.appointments.list.response.401.error`; object, required) — A valid access token is required.
  - `code` (`gmedic.appointments.list.response.401.error.code`; string, required) — The failure code, stable across releases.
    - one of `"UNAUTHORIZED"`
  - `message` (`gmedic.appointments.list.response.401.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`gmedic.appointments.list.response.401.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`gmedic.appointments.list.response.401.error.data`; object, required) — No fields.
- `metadata` (`gmedic.appointments.list.response.401.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`gmedic.appointments.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` (`gmedic.appointments.list.response.403.success`; boolean, required)
  - one of `false`
- `data` (`gmedic.appointments.list.response.403.data`; unknown, required)
- `error` (`gmedic.appointments.list.response.403.error`; object, required) — The token does not authorize this operation.
  - `code` (`gmedic.appointments.list.response.403.error.code`; string, required) — The failure code, stable across releases.
    - one of `"FORBIDDEN"`
  - `message` (`gmedic.appointments.list.response.403.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`gmedic.appointments.list.response.403.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`gmedic.appointments.list.response.403.error.data`; object, required) — No fields.
- `metadata` (`gmedic.appointments.list.response.403.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`gmedic.appointments.list.response.403.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 404

- `CONNECTION_NOT_FOUND`: This organization has no gMedic connection with this id.
- `RECORD_NOT_FOUND`: gMedic has no record with one of the ids sent.
- `APPOINTMENT_NOT_FOUND`: gMedic has no appointment with this id.

#### Example

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

- `success` (`gmedic.appointments.list.response.404.success`; boolean, required)
  - one of `false`
- `data` (`gmedic.appointments.list.response.404.data`; unknown, required)
- `error` (`gmedic.appointments.list.response.404.error`; one of, required)
  - one of: `GmedicConnectionNotFoundFailure`, `GmedicRecordNotFoundFailure`, `GmedicAppointmentNotFoundFailure`
  - discriminator: `code`
- `metadata` (`gmedic.appointments.list.response.404.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`gmedic.appointments.list.response.404.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 409

`NOT_CONFIGURED`: This organization has no verified gMedic connection.

#### Example

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

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

### 422

`PROVIDER_INPUT_REJECTED`: gMedic rejected the supplied fields.

#### Example

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

- `success` (`gmedic.appointments.list.response.422.success`; boolean, required)
  - one of `false`
- `data` (`gmedic.appointments.list.response.422.data`; unknown, required)
- `error` (`gmedic.appointments.list.response.422.error`; object, required) — gMedic rejected the supplied fields.
  - `code` (`gmedic.appointments.list.response.422.error.code`; string, required) — The failure code, stable across releases.
    - one of `"PROVIDER_INPUT_REJECTED"`
  - `message` (`gmedic.appointments.list.response.422.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`gmedic.appointments.list.response.422.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`gmedic.appointments.list.response.422.error.data`; object, required) — No fields.
- `metadata` (`gmedic.appointments.list.response.422.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`gmedic.appointments.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` (`gmedic.appointments.list.response.429.success`; boolean, required)
  - one of `false`
- `data` (`gmedic.appointments.list.response.429.data`; unknown, required)
- `error` (`gmedic.appointments.list.response.429.error`; object, required) — The request rate limit was exceeded. Try again later.
  - `code` (`gmedic.appointments.list.response.429.error.code`; string, required) — The failure code, stable across releases.
    - one of `"RATE_LIMITED"`
  - `message` (`gmedic.appointments.list.response.429.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`gmedic.appointments.list.response.429.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `true`
  - `data` (`gmedic.appointments.list.response.429.error.data`; object, required) — No fields.
- `metadata` (`gmedic.appointments.list.response.429.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`gmedic.appointments.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` (`gmedic.appointments.list.response.500.success`; boolean, required)
  - one of `false`
- `data` (`gmedic.appointments.list.response.500.data`; unknown, required)
- `error` (`gmedic.appointments.list.response.500.error`; object, required) — The service could not complete the operation.
  - `code` (`gmedic.appointments.list.response.500.error.code`; string, required) — The failure code, stable across releases.
    - one of `"INTERNAL_ERROR"`
  - `message` (`gmedic.appointments.list.response.500.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`gmedic.appointments.list.response.500.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`gmedic.appointments.list.response.500.error.data`; object, required) — No fields.
- `metadata` (`gmedic.appointments.list.response.500.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`gmedic.appointments.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_ACCESS_REJECTED`: The configured gMedic account did not authorize this operation.
- `PROVIDER_RESPONSE_INVALID`: gMedic returned an unexpected response.

#### Example

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

- `success` (`gmedic.appointments.list.response.502.success`; boolean, required)
  - one of `false`
- `data` (`gmedic.appointments.list.response.502.data`; unknown, required)
- `error` (`gmedic.appointments.list.response.502.error`; one of, required)
  - one of: `OutcomeUnknownFailure`, `GmedicProviderAccessRejectedFailure`, `GmedicProviderResponseInvalidFailure`
  - discriminator: `code`
- `metadata` (`gmedic.appointments.list.response.502.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`gmedic.appointments.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.
- `CATALOG_SEARCH_INCOMPLETE`: The service catalog search could not be completed within its limits. Service absence cannot be concluded.
- `PROVIDER_UNAVAILABLE`: gMedic is temporarily unavailable.

#### Example

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

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


Source: https://docs.getarbol.com/api/gmedic/appointments/list/index.md