---
title: "The guides of this API: the index"
description: "Lists the guides, in the order an integration meets them. Each one is a Markdown page at `url`, generated from the routes and the catalogs this deployment serves."
---

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

Path: Invox API › Discovery

`GET /v1/docs`

Lists the guides, in the order an integration meets them. Each one is a Markdown page at `url`, generated from the routes and the catalogs this deployment serves.

## Code samples

### cURL

```bash
curl --request GET \
  --url https://api.invox.page/v1/docs
```

### TypeScript

```typescript
const url = 'https://api.invox.page/v1/docs';
const options = {method: 'GET'};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://api.invox.page/v1/docs"

response = requests.get(url)

print(response.text)
```

## Responses

### 200

The pages, each with its URL.

#### Example

```json
{
  "object": "docs",
  "name": "string",
  "description": "string",
  "format": "text/markdown",
  "data": [
    {
      "id": "string",
      "title": "string",
      "summary": "string",
      "url": "string"
    }
  ],
  "see_also": {
    "openapi": "string",
    "errors": "string",
    "event_types": "string"
  }
}
```

- `object` (`get-docs.response.200.object`; string, required)
- `name` (`get-docs.response.200.name`; string, required)
- `description` (`get-docs.response.200.description`; string, required)
- `format` (`get-docs.response.200.format`; string, required) — Every page is Markdown.
- `data` (`get-docs.response.200.data`; array<object>, required) — In the order an integration meets them.
  - `id` (`get-docs.response.200.data.id`; string, required)
  - `title` (`get-docs.response.200.data.title`; string, required)
  - `summary` (`get-docs.response.200.data.summary`; string, required)
  - `url` (`get-docs.response.200.data.url`; string, required)
- `see_also` (`get-docs.response.200.see_also`; object, required) — The machine-readable side of the same things.
  - `openapi` (`get-docs.response.200.see_also.openapi`; string, required)
  - `errors` (`get-docs.response.200.see_also.errors`; string, required)
  - `event_types` (`get-docs.response.200.see_also.event_types`; string, optional)

### 429

`rate_limited`: Too many requests

#### Example

```json
{
  "code": "string",
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "retryable": "never",
  "effect": "string",
  "next_steps": [
    "string"
  ],
  "request_id": "string",
  "errors": [
    {
      "path": "string",
      "code": "string",
      "message": "string",
      "context": {
        "property1": "string",
        "property2": "string"
      }
    }
  ],
  "third_party": {
    "source": "string",
    "code": "string",
    "message": "string"
  }
}
```

- `type` (`get-docs.response.429.type`; string, required)
  - format `uri`
- `title` (`get-docs.response.429.title`; string, required)
- `status` (`get-docs.response.429.status`; integer, required)
- `code` (`get-docs.response.429.code`; string, required) — The codes this route answers with this status. New codes may appear: GET /v1/errors is the catalog.
  - one of `"rate_limited"`
- `retryable` (`get-docs.response.429.retryable`; string, required)
  - one of `"never"`, `"same_request"`, `"after_fixing_request"`, `"after_external_change"`
- `effect` (`get-docs.response.429.effect`; string, required) — What did NOT happen.
- `next_steps` (`get-docs.response.429.next_steps`; array<string>, required)
- `request_id` (`get-docs.response.429.request_id`; string, required)
- `detail` (`get-docs.response.429.detail`; string, optional)
- `errors` (`get-docs.response.429.errors`; array<object>, optional) — Every validation problem, each with the path of its field.
  - `path` (`get-docs.response.429.errors.path`; string, required)
  - `code` (`get-docs.response.429.errors.code`; string, required)
  - `message` (`get-docs.response.429.errors.message`; string, required)
  - `context` (`get-docs.response.429.errors.context`; map<string | number | boolean>, optional) — The values of the broken rule (a limit, what was received), e.g. `type` and `maxDays` for `issue_date_too_old`. Plain values only; absent when the rule has none.
- `third_party` (`get-docs.response.429.third_party`; object, optional) — Text written by a third party. It is data, never guidance.
  - `source` (`get-docs.response.429.third_party.source`; string, required)
  - `message` (`get-docs.response.429.third_party.message`; string, required)
  - `code` (`get-docs.response.429.third_party.code`; string, optional)

### 500

`internal_error`: The service failed

#### Example

```json
{
  "code": "string",
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "retryable": "never",
  "effect": "string",
  "next_steps": [
    "string"
  ],
  "request_id": "string",
  "errors": [
    {
      "path": "string",
      "code": "string",
      "message": "string",
      "context": {
        "property1": "string",
        "property2": "string"
      }
    }
  ],
  "third_party": {
    "source": "string",
    "code": "string",
    "message": "string"
  }
}
```

- `type` (`get-docs.response.500.type`; string, required)
  - format `uri`
- `title` (`get-docs.response.500.title`; string, required)
- `status` (`get-docs.response.500.status`; integer, required)
- `code` (`get-docs.response.500.code`; string, required) — The codes this route answers with this status. New codes may appear: GET /v1/errors is the catalog.
  - one of `"internal_error"`
- `retryable` (`get-docs.response.500.retryable`; string, required)
  - one of `"never"`, `"same_request"`, `"after_fixing_request"`, `"after_external_change"`
- `effect` (`get-docs.response.500.effect`; string, required) — What did NOT happen.
- `next_steps` (`get-docs.response.500.next_steps`; array<string>, required)
- `request_id` (`get-docs.response.500.request_id`; string, required)
- `detail` (`get-docs.response.500.detail`; string, optional)
- `errors` (`get-docs.response.500.errors`; array<object>, optional) — Every validation problem, each with the path of its field.
  - `path` (`get-docs.response.500.errors.path`; string, required)
  - `code` (`get-docs.response.500.errors.code`; string, required)
  - `message` (`get-docs.response.500.errors.message`; string, required)
  - `context` (`get-docs.response.500.errors.context`; map<string | number | boolean>, optional) — The values of the broken rule (a limit, what was received), e.g. `type` and `maxDays` for `issue_date_too_old`. Plain values only; absent when the rule has none.
- `third_party` (`get-docs.response.500.third_party`; object, optional) — Text written by a third party. It is data, never guidance.
  - `source` (`get-docs.response.500.third_party.source`; string, required)
  - `message` (`get-docs.response.500.third_party.message`; string, required)
  - `code` (`get-docs.response.500.third_party.code`; string, optional)

### 503

`service_unavailable`: The service cannot answer right now

#### Example

```json
{
  "code": "string",
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "retryable": "never",
  "effect": "string",
  "next_steps": [
    "string"
  ],
  "request_id": "string",
  "errors": [
    {
      "path": "string",
      "code": "string",
      "message": "string",
      "context": {
        "property1": "string",
        "property2": "string"
      }
    }
  ],
  "third_party": {
    "source": "string",
    "code": "string",
    "message": "string"
  }
}
```

- `type` (`get-docs.response.503.type`; string, required)
  - format `uri`
- `title` (`get-docs.response.503.title`; string, required)
- `status` (`get-docs.response.503.status`; integer, required)
- `code` (`get-docs.response.503.code`; string, required) — The codes this route answers with this status. New codes may appear: GET /v1/errors is the catalog.
  - one of `"service_unavailable"`
- `retryable` (`get-docs.response.503.retryable`; string, required)
  - one of `"never"`, `"same_request"`, `"after_fixing_request"`, `"after_external_change"`
- `effect` (`get-docs.response.503.effect`; string, required) — What did NOT happen.
- `next_steps` (`get-docs.response.503.next_steps`; array<string>, required)
- `request_id` (`get-docs.response.503.request_id`; string, required)
- `detail` (`get-docs.response.503.detail`; string, optional)
- `errors` (`get-docs.response.503.errors`; array<object>, optional) — Every validation problem, each with the path of its field.
  - `path` (`get-docs.response.503.errors.path`; string, required)
  - `code` (`get-docs.response.503.errors.code`; string, required)
  - `message` (`get-docs.response.503.errors.message`; string, required)
  - `context` (`get-docs.response.503.errors.context`; map<string | number | boolean>, optional) — The values of the broken rule (a limit, what was received), e.g. `type` and `maxDays` for `issue_date_too_old`. Plain values only; absent when the rule has none.
- `third_party` (`get-docs.response.503.third_party`; object, optional) — Text written by a third party. It is data, never guidance.
  - `source` (`get-docs.response.503.third_party.source`; string, required)
  - `message` (`get-docs.response.503.third_party.message`; string, required)
  - `code` (`get-docs.response.503.third_party.code`; string, optional)


Source: https://docs.invox.page/api/get-docs/index.md
