The organisations the app is installed in (and was, once it's removed)

GET

/v1/app/installations

const url = 'https://api.threadkite.app/v1/app/installations?status=active';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.threadkite.app/v1/app/installations?status=active' \
  --header 'Authorization: Bearer <token>'

Authorizations

app_token
app

Parameters

Query Parameters

organisationId

Only this organisation’s installation

string format: uuid

Only this organisation’s installation

status

Only active or only removed installations; both when left out

string

Allowed values: active removed

Only active or only removed installations; both when left out

Responses

200

application/json

Array<object>

object

required

string format: uuid

organisationId

required

string format: uuid

organisationName

required

string

grantedScopes

required

Array<string>

Allowed values: organisation:read locations:read locations:write members:read members:write items:read items:write leads:write contacts:read contacts:write contacts:delete companies:read companies:write companies:delete threads:read threads:write messages:read messages:write tasks:read tasks:write appointments:read appointments:write events:read events:write records:read records:write flows:read flows:write segments:read reports:read reports:write sales:read sales:write imports:read imports:write webhooks:manage

status

required

string

Allowed values: active removed

installedBy

required

person: an owner or admin connected it; partner: you created the organisation

string

Allowed values: person partner

installedAt

required

string format: date-time

removedAt

required

string format: date-time

nullable

lastUsedAt

required

string format: date-time

nullable

inboundId

required

Its own address for your webhooks: /v1/inbound/installations/<inboundId> on the API

string

nullable

accountId

required

The customer’s id in your system, for the app-wide webhook address

string

nullable

Example

[
  {
    "organisationName": "Smith Motors",
    "grantedScopes": [
      "organisation:read"
    ],
    "status": "active",
    "installedBy": "person",
    "inboundId": "in_8Kq2xW7mR4tZ9pL3vN6bH1cY",
    "accountId": "D-0042"
  }
]

401

Missing or invalid app token (code invalid_app_token)

application/json

object

statusCode

required

number

code

required

Stable machine-readable reason

string

message

required

string

errors

With code invalid: every problem with the request, by field (message is the first)

Array<object>

object

path

required

Dotted path inside the item, e.g. attributes.price.amountMinor

string

message

required

string

Example

{
  "statusCode": 403,
  "code": "forbidden",
  "message": "You do not have permission to do that.",
  "errors": [
    {
      "message": "Enter the make"
    }
  ]
}

429

Rate limit reached

application/json

object

statusCode

required

number

code

required

Stable machine-readable reason

string

message

required

string

retryAfter

required

Seconds until another request will be accepted

number

Example

{
  "statusCode": 429,
  "code": "rate_limited",
  "message": "Too many requests. Each key can make 120 requests a minute; try again in 12 seconds.",
  "retryAfter": 12
}