Get Current Install

Returns the install the calling token belongs to. Use it as a connectivity check after the customer pastes in their token, and to confirm which scopes and PII consent you actually hold before relying on them.

Requirements: any valid platform token — no specific scope. (Like every Platform API call, it still requires a live token, an ACTIVE install, an ACTIVE platform app, and the annotation-platform feature on the granting employer.)

Request

No parameters.

Response

installobject

The current install.

Install fields

idstring

Install ID. Also delivered as opentrain_install_id on the consent return redirect.

statusstring

ACTIVE or REVOKED. A revoked install’s tokens stop authenticating, so in practice you only ever see ACTIVE here.

scopesstring[]

The scopes the customer granted — see the scope table.

piiConsentboolean

Whether the customer checked the explicit Work Email consent box. participants:email only takes effect when this is true.

organizationIdstring | null

The granting employer’s organization ID.

createdAtstring

ISO 8601 timestamp of the grant.

partnerAppobject

Your app: {id, slug, name}.

tokenobject

The token used for this request: {id, name, scopes}.

Errors

Status	code	Meaning
401	UNAUTHORIZED	Missing, invalid, or revoked token
403	FORBIDDEN	Install or platform app no longer active, or annotation-platform feature disabled for the granting employer

Request examples

curl

curl -sS https://app.opentrain.ai/api/partner/v1/installs/current \
  -H "Authorization: Bearer $OT_PARTNER_TOKEN"

Response examples

200

{
  "install": {
    "id": "<INSTALL_ID>",
    "status": "ACTIVE",
    "scopes": [
      "project-links:read",
      "project-links:write",
      "contracts:read",
      "participants:read",
      "participants:email",
      "webhooks:manage"
    ],
    "piiConsent": true,
    "organizationId": "<ORG_ID>",
    "createdAt": "2026-06-12T10:00:00.000Z",
    "partnerApp": {
      "id": "<APP_ID>",
      "slug": "your-app",
      "name": "Your App"
    },
    "token": {
      "id": "<TOKEN_ID>",
      "name": "Your App connection",
      "scopes": [
        "project-links:read",
        "project-links:write",
        "contracts:read",
        "participants:read",
        "participants:email",
        "webhooks:manage"
      ]
    }
  }
}