---
title: "What the simulated provider can be told to answer to a void"
---

> 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 › Test mode

`GET /v1/test/void_scenarios`

## Authentication

- `bearer`, http, header `Authorization`

## Header parameters

- `X-Organization` (`get-test-void-scenarios.header.X-Organization`; string, optional) — Required with a person's access token: the organization to act on. Omit it with a service-account key.
  - format `uuid`

## Code samples

### cURL

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

### TypeScript

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

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

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

print(response.text)
```

## Responses

### 200

The void scenarios, what each one does and how to resolve the one that waits.

#### Example

```json
{
  "how_to_use": "string",
  "default": "string",
  "deterministic": "string",
  "precedence": "string",
  "skip_a_wait": "string",
  "data": [
    {
      "name": "string",
      "summary": "string",
      "outcome": "string",
      "parameters": {
        "property1": "string",
        "property2": "string"
      },
      "resolve_with": {
        "route": "string",
        "outcomes": [
          "string"
        ]
      }
    }
  ],
  "limits": {
    "max_polls": -9007199254740991
  }
}
```

- `how_to_use` (`get-test-void-scenarios.response.200.how_to_use`; string, required)
- `default` (`get-test-void-scenarios.response.200.default`; string, required)
- `deterministic` (`get-test-void-scenarios.response.200.deterministic`; string, required)
- `precedence` (`get-test-void-scenarios.response.200.precedence`; string, required)
- `skip_a_wait` (`get-test-void-scenarios.response.200.skip_a_wait`; string, required)
- `data` (`get-test-void-scenarios.response.200.data`; array<object>, required)
  - `name` (`get-test-void-scenarios.response.200.data.name`; string, required)
  - `summary` (`get-test-void-scenarios.response.200.data.summary`; string, required)
  - `outcome` (`get-test-void-scenarios.response.200.data.outcome`; string, required)
  - `parameters` (`get-test-void-scenarios.response.200.data.parameters`; any of, required) — What can follow the name in the header (`<name>; <parameter>=<value>`), or `null`.
    - any of: `map<string>`, `null`
  - `resolve_with` (`get-test-void-scenarios.response.200.data.resolve_with`; any of, required)
    - any of:
      - `object`
        - `route` (`get-test-void-scenarios.response.200.data.resolve_with.1.route`; string, required)
        - `outcomes` (`get-test-void-scenarios.response.200.data.resolve_with.1.outcomes`; array<string>, required)
      - `null`
- `limits` (`get-test-void-scenarios.response.200.limits`; object, required)
  - `max_polls` (`get-test-void-scenarios.response.200.limits.max_polls`; integer, required)
    - min -9007199254740991; max 9007199254740991

### 400

`organization_required`: This credential needs to say which organization it acts on

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

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

### 403

`missing_scope`: The credential lacks the permission this operation requires · `organization_mismatch`: The X-Organization header names another organization than the key's · `test_only_route`: This route only exists in a test organization

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

### 404

`not_found`: The resource does not exist in this organization

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


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