---
title: "List available days"
description: "Use the organization gMedic account. Read-only request; provider failures are never empty results.\n\n- **Scope:** `gmedic:availability: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 available-days list` · **MCP tool:** `gmedic_available_days_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 › Available days

`GET /v1/gmedic/available-days`

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

- **Scope:** `gmedic:availability: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 available-days list` · **MCP tool:** `gmedic_available_days_list`

## Authentication

Requires one of the following:

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

## Query parameters

- `agendaId` (`gmedic.availableDays.list.query.agendaId`; string, required) — The agenda id.
  - pattern `^[1-9][0-9]{0,14}$`
- `month` (`gmedic.availableDays.list.query.month`; string, required) — The month.
  - maxLength 20000; pattern `^[0-9]{6}$`
- `cursor` (`gmedic.availableDays.list.query.cursor`; string, optional) — Opaque cursor returned by pageInfo; omit it to request the first page.
- `direction` (`gmedic.availableDays.list.query.direction`; string, optional) — Direction to traverse the stable keyset ordering from the supplied cursor.
  - one of `"forward"`, `"backward"`; default `"forward"`
- `limit` (`gmedic.availableDays.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` (`gmedic.availableDays.list.query.connectionId`; string, optional) — The connection id.
  - pattern `^con_[0-9A-Za-z]{26}$`

## Code samples

### cURL

```bash
curl "https://api.getarbol.com/v1/gmedic/available-days?agendaId=<agendaId>&month=<month>" \
  --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.availableDays.list({
  agendaId: "<agendaId>",
  month: "<month>",
});
```

### Rust

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

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

let data = arbol
    .gmedic()
    .available_days()
    .list(&types::GmedicAvailableDaysListInput {
        agenda_id: "<agendaId>".into(),
        month: "<month>".into(),
        cursor: None,
        direction: None,
        limit: None,
        connection_id: None,
    })
    .await?;
```

### CLI

```bash
arbol gmedic available-days list --agenda-id '<agendaId>' --month '<month>'
```

### MCP

```json
{
  "name": "gmedic_available_days_list",
  "arguments": {
    "agendaId": "<agendaId>",
    "month": "<month>"
  }
}
```

## Responses

### 200

Successful operation.

#### Example

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

- `success` (`gmedic.availableDays.list.response.200.success`; boolean, required)
  - one of `true`
- `data` (`gmedic.availableDays.list.response.200.data`; object, required)
  - `data` (`gmedic.availableDays.list.response.200.data.data`; array<string>, required) — Items admitted by this resource contract within the verified organization.
    - maxLength 20000
  - `object` (`gmedic.availableDays.list.response.200.data.object`; string, required) — Discriminator for a resource list response.
  - `pageInfo` (`gmedic.availableDays.list.response.200.data.pageInfo`; object, required) — Opaque navigation cursors for this page’s stable keyset order.
    - `hasNextPage` (`gmedic.availableDays.list.response.200.data.pageInfo.hasNextPage`; boolean, required) — Whether a later page exists in the current ordering.
    - `hasPreviousPage` (`gmedic.availableDays.list.response.200.data.pageInfo.hasPreviousPage`; boolean, required) — Whether an earlier page exists in the current ordering.
    - `nextCursor` (`gmedic.availableDays.list.response.200.data.pageInfo.nextCursor`; string | null, required) — Opaque cursor for the next page, or null when there is none.
    - `previousCursor` (`gmedic.availableDays.list.response.200.data.pageInfo.previousCursor`; string | null, required) — Opaque cursor for the previous page, or null when there is none.
- `error` (`gmedic.availableDays.list.response.200.error`; unknown, required)
- `metadata` (`gmedic.availableDays.list.response.200.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`gmedic.availableDays.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.availableDays.list.response.400.success`; boolean, required)
  - one of `false`
- `data` (`gmedic.availableDays.list.response.400.data`; unknown, required)
- `error` (`gmedic.availableDays.list.response.400.error`; object, required) — The request does not match the published schema.
  - `code` (`gmedic.availableDays.list.response.400.error.code`; string, required) — The failure code, stable across releases.
    - one of `"INVALID_INPUT"`
  - `message` (`gmedic.availableDays.list.response.400.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`gmedic.availableDays.list.response.400.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`gmedic.availableDays.list.response.400.error.data`; object, required)
    - `issues` (`gmedic.availableDays.list.response.400.error.data.issues`; array<object>, optional)
      - `path` (`gmedic.availableDays.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.availableDays.list.response.400.error.data.issues.message`; string, required)
        - maxLength 256
- `metadata` (`gmedic.availableDays.list.response.400.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`gmedic.availableDays.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.availableDays.list.response.401.success`; boolean, required)
  - one of `false`
- `data` (`gmedic.availableDays.list.response.401.data`; unknown, required)
- `error` (`gmedic.availableDays.list.response.401.error`; object, required) — A valid access token is required.
  - `code` (`gmedic.availableDays.list.response.401.error.code`; string, required) — The failure code, stable across releases.
    - one of `"UNAUTHORIZED"`
  - `message` (`gmedic.availableDays.list.response.401.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`gmedic.availableDays.list.response.401.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`gmedic.availableDays.list.response.401.error.data`; object, required) — No fields.
- `metadata` (`gmedic.availableDays.list.response.401.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`gmedic.availableDays.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.availableDays.list.response.403.success`; boolean, required)
  - one of `false`
- `data` (`gmedic.availableDays.list.response.403.data`; unknown, required)
- `error` (`gmedic.availableDays.list.response.403.error`; object, required) — The token does not authorize this operation.
  - `code` (`gmedic.availableDays.list.response.403.error.code`; string, required) — The failure code, stable across releases.
    - one of `"FORBIDDEN"`
  - `message` (`gmedic.availableDays.list.response.403.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`gmedic.availableDays.list.response.403.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`gmedic.availableDays.list.response.403.error.data`; object, required) — No fields.
- `metadata` (`gmedic.availableDays.list.response.403.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`gmedic.availableDays.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.

#### Example

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

- `success` (`gmedic.availableDays.list.response.404.success`; boolean, required)
  - one of `false`
- `data` (`gmedic.availableDays.list.response.404.data`; unknown, required)
- `error` (`gmedic.availableDays.list.response.404.error`; one of, required)
  - one of: `GmedicConnectionNotFoundFailure`, `GmedicRecordNotFoundFailure`
  - discriminator: `code`
- `metadata` (`gmedic.availableDays.list.response.404.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`gmedic.availableDays.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.availableDays.list.response.409.success`; boolean, required)
  - one of `false`
- `data` (`gmedic.availableDays.list.response.409.data`; unknown, required)
- `error` (`gmedic.availableDays.list.response.409.error`; object, required) — This organization has no verified gMedic connection.
  - `code` (`gmedic.availableDays.list.response.409.error.code`; string, required) — The failure code, stable across releases.
    - one of `"NOT_CONFIGURED"`
  - `message` (`gmedic.availableDays.list.response.409.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`gmedic.availableDays.list.response.409.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`gmedic.availableDays.list.response.409.error.data`; object, required) — No fields.
- `metadata` (`gmedic.availableDays.list.response.409.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`gmedic.availableDays.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.availableDays.list.response.422.success`; boolean, required)
  - one of `false`
- `data` (`gmedic.availableDays.list.response.422.data`; unknown, required)
- `error` (`gmedic.availableDays.list.response.422.error`; object, required) — gMedic rejected the supplied fields.
  - `code` (`gmedic.availableDays.list.response.422.error.code`; string, required) — The failure code, stable across releases.
    - one of `"PROVIDER_INPUT_REJECTED"`
  - `message` (`gmedic.availableDays.list.response.422.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`gmedic.availableDays.list.response.422.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`gmedic.availableDays.list.response.422.error.data`; object, required) — No fields.
- `metadata` (`gmedic.availableDays.list.response.422.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`gmedic.availableDays.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.availableDays.list.response.429.success`; boolean, required)
  - one of `false`
- `data` (`gmedic.availableDays.list.response.429.data`; unknown, required)
- `error` (`gmedic.availableDays.list.response.429.error`; object, required) — The request rate limit was exceeded. Try again later.
  - `code` (`gmedic.availableDays.list.response.429.error.code`; string, required) — The failure code, stable across releases.
    - one of `"RATE_LIMITED"`
  - `message` (`gmedic.availableDays.list.response.429.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`gmedic.availableDays.list.response.429.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `true`
  - `data` (`gmedic.availableDays.list.response.429.error.data`; object, required) — No fields.
- `metadata` (`gmedic.availableDays.list.response.429.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`gmedic.availableDays.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.availableDays.list.response.500.success`; boolean, required)
  - one of `false`
- `data` (`gmedic.availableDays.list.response.500.data`; unknown, required)
- `error` (`gmedic.availableDays.list.response.500.error`; object, required) — The service could not complete the operation.
  - `code` (`gmedic.availableDays.list.response.500.error.code`; string, required) — The failure code, stable across releases.
    - one of `"INTERNAL_ERROR"`
  - `message` (`gmedic.availableDays.list.response.500.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`gmedic.availableDays.list.response.500.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`gmedic.availableDays.list.response.500.error.data`; object, required) — No fields.
- `metadata` (`gmedic.availableDays.list.response.500.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`gmedic.availableDays.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.availableDays.list.response.502.success`; boolean, required)
  - one of `false`
- `data` (`gmedic.availableDays.list.response.502.data`; unknown, required)
- `error` (`gmedic.availableDays.list.response.502.error`; one of, required)
  - one of: `OutcomeUnknownFailure`, `GmedicProviderAccessRejectedFailure`, `GmedicProviderResponseInvalidFailure`
  - discriminator: `code`
- `metadata` (`gmedic.availableDays.list.response.502.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`gmedic.availableDays.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.availableDays.list.response.503.success`; boolean, required)
  - one of `false`
- `data` (`gmedic.availableDays.list.response.503.data`; unknown, required)
- `error` (`gmedic.availableDays.list.response.503.error`; one of, required)
  - one of: `UpstreamUnavailableFailure`, `GmedicCatalogSearchIncompleteFailure`, `GmedicProviderUnavailableFailure`
  - discriminator: `code`
- `metadata` (`gmedic.availableDays.list.response.503.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`gmedic.availableDays.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.availableDays.list.response.504.success`; boolean, required)
  - one of `false`
- `data` (`gmedic.availableDays.list.response.504.data`; unknown, required)
- `error` (`gmedic.availableDays.list.response.504.error`; object, required) — The upstream service did not respond before its deadline.
  - `code` (`gmedic.availableDays.list.response.504.error.code`; string, required) — The failure code, stable across releases.
    - one of `"UPSTREAM_TIMEOUT"`
  - `message` (`gmedic.availableDays.list.response.504.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`gmedic.availableDays.list.response.504.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `true`
  - `data` (`gmedic.availableDays.list.response.504.error.data`; object, required) — No fields.
- `metadata` (`gmedic.availableDays.list.response.504.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`gmedic.availableDays.list.response.504.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.


Source: https://docs.getarbol.com/api/gmedic/available-days/list/index.md