Skip to main content
Preview archiving a company

Authorizations

Authorization
string
header
required

Personal API key sent as a bearer token, together with X-Organization-Id. The key must have at least the access level the endpoint requires (read, write or admin).

Headers

X-Organization-Id
string

The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations.

Path Parameters

id
string<uuid>
required

Response

What archiving would do.

archived
boolean
required

The company is archived already; archiving changes nothing.

can_archive
boolean
required

Nothing blocks archiving: no open work, and another company stays in use.

last_company
boolean
required

The only company of the workspace in use. A workspace keeps at least one, so it cannot be archived.

open_work
object
required

What must be finished or cancelled before the company can be archived.

channels
object[]
required

Where invoices reach the company, and what archiving does to each.

members_limited
object[]
required

Members whose access is limited to this company. They keep reading its history while it is archived.