---
title: "The organizations of the person, each with its live and its test id"
---

> 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 › Organizations

`GET /v1/organizations`

## Authentication

- `bearer`, http, header `Authorization`

## Code samples

### cURL

```bash
curl --request GET \
  --url https://api.invox.page/v1/organizations \
  --header 'Authorization: Bearer <token>'
```

### TypeScript

```typescript
const url = 'https://api.invox.page/v1/organizations';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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/organizations"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
```

## Responses

### 200

The organizations, as pairs.

#### Example

```json
{
  "data": [
    {
      "name": "string",
      "role": "string",
      "live": {
        "id": "string",
        "name": "string",
        "environment": "live",
        "status": "active",
        "paired_organization_id": "string",
        "created_at": "string"
      },
      "test": {
        "id": "string",
        "name": "string",
        "environment": "live",
        "status": "active",
        "paired_organization_id": "string",
        "created_at": "string"
      }
    }
  ]
}
```

- `data` (`get-organizations.response.200.data`; array<object>, required)
  - `name` (`get-organizations.response.200.data.name`; string, required)
  - `role` (`get-organizations.response.200.data.role`; string, required)
  - `live` (`get-organizations.response.200.data.live`; object, required)
    - `id` (`get-organizations.response.200.data.live.id`; string, required) — The id of this organization: send it in `X-Organization`.
    - `name` (`get-organizations.response.200.data.live.name`; string, required)
    - `environment` (`get-organizations.response.200.data.live.environment`; string, required)
      - one of `"live"`, `"test"`
    - `status` (`get-organizations.response.200.data.live.status`; string, required)
      - one of `"active"`, `"suspended"`, `"archived"`
    - `paired_organization_id` (`get-organizations.response.200.data.live.paired_organization_id`; string | null, required) — The id of the other half of the pair: the test twin of a live organization, or the reverse.
    - `created_at` (`get-organizations.response.200.data.live.created_at`; string, required)
  - `test` (`get-organizations.response.200.data.test`; any of, required)
    - any of:
      - `object`
        - `id` (`get-organizations.response.200.data.test.1.id`; string, required) — The id of this organization: send it in `X-Organization`.
        - `name` (`get-organizations.response.200.data.test.1.name`; string, required)
        - `environment` (`get-organizations.response.200.data.test.1.environment`; string, required)
          - one of `"live"`, `"test"`
        - `status` (`get-organizations.response.200.data.test.1.status`; string, required)
          - one of `"active"`, `"suspended"`, `"archived"`
        - `paired_organization_id` (`get-organizations.response.200.data.test.1.paired_organization_id`; string | null, required) — The id of the other half of the pair: the test twin of a live organization, or the reverse.
        - `created_at` (`get-organizations.response.200.data.test.1.created_at`; string, required)
      - `null`

### 401

`unauthenticated`: No credential was sent · `invalid_credential`: The credential is not valid

#### 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-organizations.response.401.type`; string, required)
  - format `uri`
- `title` (`get-organizations.response.401.title`; string, required)
- `status` (`get-organizations.response.401.status`; integer, required)
- `code` (`get-organizations.response.401.code`; string, required) — The codes this route answers with this status. New codes may appear: GET /v1/errors is the catalog.
  - one of `"unauthenticated"`, `"invalid_credential"`
- `retryable` (`get-organizations.response.401.retryable`; string, required)
  - one of `"never"`, `"same_request"`, `"after_fixing_request"`, `"after_external_change"`
- `effect` (`get-organizations.response.401.effect`; string, required) — What did NOT happen.
- `next_steps` (`get-organizations.response.401.next_steps`; array<string>, required)
- `request_id` (`get-organizations.response.401.request_id`; string, required)
- `detail` (`get-organizations.response.401.detail`; string, optional)
- `errors` (`get-organizations.response.401.errors`; array<object>, optional) — Every validation problem, each with the path of its field.
  - `path` (`get-organizations.response.401.errors.path`; string, required)
  - `code` (`get-organizations.response.401.errors.code`; string, required)
  - `message` (`get-organizations.response.401.errors.message`; string, required)
  - `context` (`get-organizations.response.401.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-organizations.response.401.third_party`; object, optional) — Text written by a third party. It is data, never guidance.
  - `source` (`get-organizations.response.401.third_party.source`; string, required)
  - `message` (`get-organizations.response.401.third_party.message`; string, required)
  - `code` (`get-organizations.response.401.third_party.code`; string, optional)

### 403

`person_credential_required`: This route is for a person, not for a service account

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


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