List a customer's entities

GEThttps://app.booksbyinstant.com/api/integrator/v1/customers/{id}/entities

The customer's legal entities, which a selected entity access names: oldest first, archived ones included, no paging. A new customer has none until its setup has made one.

listEntities · This page as markdown

Example request

cURL

curl -X GET 'https://app.booksbyinstant.com/api/integrator/v1/customers/01900000-0000-7000-8000-000000000000/entities' \
  -H "Authorization: Bearer $INTEGRATOR_CREDENTIAL"

JavaScript

// Node 18 or later, in an ES module (.mjs), which allows the top-level await.
const res = await fetch("https://app.booksbyinstant.com/api/integrator/v1/customers/01900000-0000-7000-8000-000000000000/entities", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.INTEGRATOR_CREDENTIAL}`,
  },
});
const data = await res.json();

Python

import os
import requests

res = requests.get(
    "https://app.booksbyinstant.com/api/integrator/v1/customers/01900000-0000-7000-8000-000000000000/entities",
    headers={
        "Authorization": f"Bearer {os.environ['INTEGRATOR_CREDENTIAL']}",
    },
)
data = res.json()

Authorization

Bearer token live_<100 hex>

Authorization: Bearer <secret>. A 401 answers WWW-Authenticate: Bearer realm="instant-integrator-api".

Path parameters

id string · uuid required

The customer's id.

Responses

200

The entities.

Body application/json

object

entities array of object required

Each item
- id string · uuid required
  
  The entity's id, which a selected entity access names.
- name string required
  
  The entity's name.
- legalName string or null required
  
  Its legal name, or null when it is not known.
- country string required
  
  Its ISO 3166-1 alpha-2 country code.
- legalForm string or null required
  
  Its legal form, such as ApS, or null when it is not known.
- functionalCurrency string required
  
  The ISO 4217 code of the currency its books are kept in.
- status string required
  
  archived once the entity is archived; it stays in the list.
  
  One of active archived
- createdAt string · date-time required
  
  When the entity was created. ISO 8601 in UTC with milliseconds, such as 2026-11-06T10:00:00.000Z.

Example, built from the schema

{
  "entities": [
    {
      "id": "01900000-0000-7000-8000-000000000000",
      "name": "string",
      "legalName": "string",
      "country": "string",
      "legalForm": "string",
      "functionalCurrency": "string",
      "status": "active",
      "createdAt": "2026-01-15T09:30:00.000Z"
    }
  ]
}

401

The credential is missing, malformed, unknown, revoked or rotated, or its integrator is disabled. All of these answer the same way.

Headers

WWW-Authenticate string

Bearer realm="instant-integrator-api"

Body application/json

object Error

Every answer that is not a success.

error string required

Instant's sentence for people. A 4xx keeps the refusal's own sentence; a 5xx always says "Instant is temporarily unavailable. Please try again shortly."
code string required

Stable, and what a caller branches on: VALIDATION_ERROR (400), UNAUTHENTICATED (401), FORBIDDEN (403), NOT_FOUND (404), CONFLICT (409), LIMIT_EXCEEDED (413), UNSUPPORTED_MEDIA_TYPE (415), UNREADABLE_FILE (422), RATE_LIMITED (429) and UNAVAILABLE (5xx). More codes may be added; treat one you do not know by its status.
retryAfter integer

Seconds to wait before retrying, also sent as the Retry-After header. Present only when there is a wait, as on a 429.

at least 1
existingId string · uuid

On a 409 that names the object already there, such as a customer with that reference: its id.

Example, built from the schema

{
  "error": "string",
  "code": "VALIDATION_ERROR",
  "retryAfter": 1,
  "existingId": "01900000-0000-7000-8000-000000000000"
}

404

id names nothing this caller can see.

Body application/json

The Error object, as in 401.

5XX

Instant is temporarily unavailable. Retry later, with backoff.

Body application/json

The Error object, as in 401.