Skip to main content
GET
Get an installation

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

installation_id
integer<int64>
required

The unique identifier for the installation.

Response

Successfully retrieved the installation.

An installation represents an app that has been installed for a company.

id
integer<int64>
required

Unique identifier for the installation.

Example:

12345

app_id
integer<int64>
required

The ID of the installed app.

Example:

67

company_id
integer<int64>
required

The ID of the company that installed the app.

Example:

345

tier_id
string
required

The tier selected during installation.

Example:

"basic"

permissions
object[]
required

The permissions granted to this installation.

installation_time
string
required

When the installation happened, as an ISO 8601 local date-time with no offset or zone — 2024-01-15T10:30:00. Read it as UTC. This is deliberately not format: date-time, which means RFC 3339 and would require an offset the server does not send.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?$
Example:

"2024-01-15T10:30:00"