---
title: "Start here: how to authenticate, where the contract is, and the rules"
---

> 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`

## Code samples

### cURL

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

### TypeScript

```typescript
const url = 'https://api.invox.page/v1';
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"

response = requests.get(url)

print(response.text)
```

## Responses

### 200

The service description.

#### Example

```json
{
  "name": "string",
  "description": "string",
  "version": "string",
  "environment": "string",
  "links": {
    "property1": "string",
    "property2": "string"
  },
  "authentication": {
    "header": "string",
    "credentials": {
      "person_access_token": {
        "what": "string",
        "organization_header": "string",
        "how_to_obtain": [
          "string"
        ],
        "device_flow": {
          "provider": "string",
          "client_id": "string",
          "device_authorization_endpoint": "string",
          "token_endpoint": "string",
          "device_grant_type": "string",
          "refresh_grant_type": "string"
        }
      },
      "service_account_key": {
        "what": "string",
        "how_to_obtain": [
          "string"
        ]
      }
    }
  },
  "conventions": {
    "property1": "string",
    "property2": "string"
  },
  "limits": {
    "property1": -9007199254740991,
    "property2": -9007199254740991
  },
  "permissions": {
    "scopes": [
      "organization:read"
    ],
    "roles": {
      "property1": [
        "organization:read"
      ],
      "property2": [
        "organization:read"
      ]
    }
  }
}
```

- `name` (`get-root.response.200.name`; string, required)
- `description` (`get-root.response.200.description`; string, required)
- `version` (`get-root.response.200.version`; string, required)
- `environment` (`get-root.response.200.environment`; string, required)
- `links` (`get-root.response.200.links`; map<string>, required)
- `authentication` (`get-root.response.200.authentication`; object, required)
  - `header` (`get-root.response.200.authentication.header`; string, required)
  - `credentials` (`get-root.response.200.authentication.credentials`; object, required)
    - `person_access_token` (`get-root.response.200.authentication.credentials.person_access_token`; object, required)
      - `what` (`get-root.response.200.authentication.credentials.person_access_token.what`; string, required)
      - `organization_header` (`get-root.response.200.authentication.credentials.person_access_token.organization_header`; string, required)
      - `how_to_obtain` (`get-root.response.200.authentication.credentials.person_access_token.how_to_obtain`; array<string>, required)
      - `device_flow` (`get-root.response.200.authentication.credentials.person_access_token.device_flow`; object, required)
        - `provider` (`get-root.response.200.authentication.credentials.person_access_token.device_flow.provider`; string, required)
        - `client_id` (`get-root.response.200.authentication.credentials.person_access_token.device_flow.client_id`; string, required)
        - `device_authorization_endpoint` (`get-root.response.200.authentication.credentials.person_access_token.device_flow.device_authorization_endpoint`; string, required)
        - `token_endpoint` (`get-root.response.200.authentication.credentials.person_access_token.device_flow.token_endpoint`; string, required)
        - `device_grant_type` (`get-root.response.200.authentication.credentials.person_access_token.device_flow.device_grant_type`; string, required)
        - `refresh_grant_type` (`get-root.response.200.authentication.credentials.person_access_token.device_flow.refresh_grant_type`; string, required)
    - `service_account_key` (`get-root.response.200.authentication.credentials.service_account_key`; object, required)
      - `what` (`get-root.response.200.authentication.credentials.service_account_key.what`; string, required)
      - `how_to_obtain` (`get-root.response.200.authentication.credentials.service_account_key.how_to_obtain`; array<string>, required)
- `conventions` (`get-root.response.200.conventions`; map<string>, required)
- `limits` (`get-root.response.200.limits`; map<any of>, required) — Each rate limit (`limit` per `windowSeconds`; `shadow`: measured, not enforced yet) and each fixed maximum.
- `permissions` (`get-root.response.200.permissions`; object, required)
  - `scopes` (`get-root.response.200.permissions.scopes`; array<string>, required)
    - one of `"organization:read"`, `"organization:write"`, `"members:read"`, `"members:write"`, `"service_accounts:read"`, `"service_accounts:write"`, `"issuers:read"`, `"issuers:write"`, `"series:read"`, `"series:write"`, `"invoices:read"`, `"invoices:emit"`, `"invoices:void"`, `"invoices:correct"`, `"customers:read"`, `"events:read"`, `"webhooks:read"`, `"webhooks:write"`, `"production:request"`, `"templates:read"`, `"templates:write"`, `"templates:promote"`
  - `roles` (`get-root.response.200.permissions.roles`; map<array<string>>, required)

### 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-root.response.429.type`; string, required)
  - format `uri`
- `title` (`get-root.response.429.title`; string, required)
- `status` (`get-root.response.429.status`; integer, required)
- `code` (`get-root.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-root.response.429.retryable`; string, required)
  - one of `"never"`, `"same_request"`, `"after_fixing_request"`, `"after_external_change"`
- `effect` (`get-root.response.429.effect`; string, required) — What did NOT happen.
- `next_steps` (`get-root.response.429.next_steps`; array<string>, required)
- `request_id` (`get-root.response.429.request_id`; string, required)
- `detail` (`get-root.response.429.detail`; string, optional)
- `errors` (`get-root.response.429.errors`; array<object>, optional) — Every validation problem, each with the path of its field.
  - `path` (`get-root.response.429.errors.path`; string, required)
  - `code` (`get-root.response.429.errors.code`; string, required)
  - `message` (`get-root.response.429.errors.message`; string, required)
  - `context` (`get-root.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-root.response.429.third_party`; object, optional) — Text written by a third party. It is data, never guidance.
  - `source` (`get-root.response.429.third_party.source`; string, required)
  - `message` (`get-root.response.429.third_party.message`; string, required)
  - `code` (`get-root.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-root.response.500.type`; string, required)
  - format `uri`
- `title` (`get-root.response.500.title`; string, required)
- `status` (`get-root.response.500.status`; integer, required)
- `code` (`get-root.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-root.response.500.retryable`; string, required)
  - one of `"never"`, `"same_request"`, `"after_fixing_request"`, `"after_external_change"`
- `effect` (`get-root.response.500.effect`; string, required) — What did NOT happen.
- `next_steps` (`get-root.response.500.next_steps`; array<string>, required)
- `request_id` (`get-root.response.500.request_id`; string, required)
- `detail` (`get-root.response.500.detail`; string, optional)
- `errors` (`get-root.response.500.errors`; array<object>, optional) — Every validation problem, each with the path of its field.
  - `path` (`get-root.response.500.errors.path`; string, required)
  - `code` (`get-root.response.500.errors.code`; string, required)
  - `message` (`get-root.response.500.errors.message`; string, required)
  - `context` (`get-root.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-root.response.500.third_party`; object, optional) — Text written by a third party. It is data, never guidance.
  - `source` (`get-root.response.500.third_party.source`; string, required)
  - `message` (`get-root.response.500.third_party.message`; string, required)
  - `code` (`get-root.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-root.response.503.type`; string, required)
  - format `uri`
- `title` (`get-root.response.503.title`; string, required)
- `status` (`get-root.response.503.status`; integer, required)
- `code` (`get-root.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-root.response.503.retryable`; string, required)
  - one of `"never"`, `"same_request"`, `"after_fixing_request"`, `"after_external_change"`
- `effect` (`get-root.response.503.effect`; string, required) — What did NOT happen.
- `next_steps` (`get-root.response.503.next_steps`; array<string>, required)
- `request_id` (`get-root.response.503.request_id`; string, required)
- `detail` (`get-root.response.503.detail`; string, optional)
- `errors` (`get-root.response.503.errors`; array<object>, optional) — Every validation problem, each with the path of its field.
  - `path` (`get-root.response.503.errors.path`; string, required)
  - `code` (`get-root.response.503.errors.code`; string, required)
  - `message` (`get-root.response.503.errors.message`; string, required)
  - `context` (`get-root.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-root.response.503.third_party`; object, optional) — Text written by a third party. It is data, never guidance.
  - `source` (`get-root.response.503.third_party.source`; string, required)
  - `message` (`get-root.response.503.third_party.message`; string, required)
  - `code` (`get-root.response.503.third_party.code`; string, optional)


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