# Instant integrator API

> What an integrator's servers call to run their customers in Instant: the customers, their members and the members' tokens, the webhook Instant posts to, and the return URL. Every request carries the integrator's credential as Authorization: Bearer <credential>.

Base URL `https://app.booksbyinstant.com`. 24 operations under 7 tags, and 12 webhook kinds.

Every page is markdown at its address plus `index.md`, as linked below. Everything in one file: [llms-full.txt](https://booksbyinstant.com/docs/llms-full.txt). The OpenAPI document: [openapi.json](https://booksbyinstant.com/docs/openapi.json).

## Guide

- [Instant integrator API guide](https://booksbyinstant.com/docs/guide/index.md): The integrator API is what an integrator's servers call to run their customers in Instant: the customers, their members and the members' tokens, the webhook…
- [Overview](https://booksbyinstant.com/docs/index.md): the base URL, authentication and every operation

## Reference

### Integrator

Which integrator a credential belongs to.

- [Read the integrator](https://booksbyinstant.com/docs/integrator-me/index.md): `GET /api/integrator/v1/me`

### Customers

The integrator's customers: each is a company in Instant, created with its first member, who owns it.

- [List customers](https://booksbyinstant.com/docs/list-customers/index.md): `GET /api/integrator/v1/customers`
- [Create a customer](https://booksbyinstant.com/docs/create-customer/index.md): `POST /api/integrator/v1/customers`
- [Read a customer](https://booksbyinstant.com/docs/read-customer/index.md): `GET /api/integrator/v1/customers/{id}`
- [Pause, resume or hand over a customer](https://booksbyinstant.com/docs/update-customer/index.md): `PATCH /api/integrator/v1/customers/{id}`
- [List a customer's entities](https://booksbyinstant.com/docs/list-entities/index.md): `GET /api/integrator/v1/customers/{id}/entities`

### Members

The people of a customer, each with a role and entity access.

- [List a customer's members](https://booksbyinstant.com/docs/list-members/index.md): `GET /api/integrator/v1/customers/{id}/members`
- [Add a member](https://booksbyinstant.com/docs/create-member/index.md): `POST /api/integrator/v1/customers/{id}/members`
- [Read a member](https://booksbyinstant.com/docs/read-member/index.md): `GET /api/integrator/v1/customers/{id}/members/{memberId}`
- [Change, deactivate or reactivate a member](https://booksbyinstant.com/docs/update-member/index.md): `PATCH /api/integrator/v1/customers/{id}/members/{memberId}`

### Member tokens

The secrets a member's requests to the customer API carry. The integrator issues them.

- [List a member's tokens](https://booksbyinstant.com/docs/list-member-tokens/index.md): `GET /api/integrator/v1/customers/{id}/members/{memberId}/tokens`
- [Issue a member token](https://booksbyinstant.com/docs/issue-member-token/index.md): `POST /api/integrator/v1/customers/{id}/members/{memberId}/tokens`
- [Revoke a member token](https://booksbyinstant.com/docs/revoke-member-token/index.md): `DELETE /api/integrator/v1/customers/{id}/members/{memberId}/tokens/{tokenId}`

### Webhook

Where Instant posts what happens in the integrator's customers and when the docs change, and the deliveries it made.

- [Read the webhook](https://booksbyinstant.com/docs/read-webhook/index.md): `GET /api/integrator/v1/webhook`
- [Set the webhook](https://booksbyinstant.com/docs/set-webhook/index.md): `PUT /api/integrator/v1/webhook`
- [Remove the webhook](https://booksbyinstant.com/docs/clear-webhook/index.md): `DELETE /api/integrator/v1/webhook`
- [List webhook deliveries](https://booksbyinstant.com/docs/list-deliveries/index.md): `GET /api/integrator/v1/webhook/deliveries`

### Return URL

Where a member's browser comes back after connecting a mailbox, a calendar or a bank.

- [Read the return origins](https://booksbyinstant.com/docs/read-return-origins/index.md): `GET /api/integrator/v1/return-origins`
- [Set the return origins](https://booksbyinstant.com/docs/set-return-origins/index.md): `PUT /api/integrator/v1/return-origins`
- [Read the return URL](https://booksbyinstant.com/docs/read-return-url/index.md): `GET /api/integrator/v1/return-url`
- [Set the return URL](https://booksbyinstant.com/docs/set-return-url/index.md): `PUT /api/integrator/v1/return-url`
- [Clear the return URL](https://booksbyinstant.com/docs/clear-return-url/index.md): `DELETE /api/integrator/v1/return-url`

### Docs

This API's reference and guide, and the customer API's, as Instant serves them now.

- [Read a guide](https://booksbyinstant.com/docs/read-guide/index.md): `GET /api/integrator/v1/docs/guide.md`
- [Read an OpenAPI reference](https://booksbyinstant.com/docs/read-open-api/index.md): `GET /api/integrator/v1/docs/openapi.json`

## Webhooks

- [Webhooks](https://booksbyinstant.com/docs/webhooks/index.md): the headers, payload and answer of every kind
  - `approval.due`: A member's turn to approve
  - `browser.takeover_needed`: Reserved: not sent yet
  - `connection.expired`: A bank consent ran out
  - `connection.synced`: A bank backfill or asked read ended
  - `customer.paused`: A customer was paused
  - `customer.resumed`: A customer was resumed
  - `docs.updated`: The docs changed
  - `link.finished`: A bank link ended
  - `ping.raised`: A notice to a member
  - `reply.ready`: A chat reply is ready
  - `run.finished`: Background work finished
  - `task.input_needed`: A task needs its owner

## Versions

- [openapi.json](https://booksbyinstant.com/docs/openapi.json): SHA-256 `2254e14395856652b73a0371ff5256341991186a93ca59ff8a6f9e26f5318b09`
- [guide/index.md](https://booksbyinstant.com/docs/guide/index.md): SHA-256 `77ab80d3a775f01d0a8f7712734b5cdd2ce13549408f00464e886c6ab5a9961d`