Connection

Read this connection's access

What this AI-assistant connection may do, read by the connection itself: the token's grants, and under meta.access one row per business the person belongs to with their role there (permission), the access today (none, read or write), the most that role can grant (most_allowed) and, when that is less than write, the reason; the last row is the person's own account. Call it before offering to change access, so you can say what is possible: an owner, admin or manager can allow read and write; a contractor or viewer stays read only, and only a role change by the business lifts that.

A connection starts with read and write wherever the person's role allows it (since 2026-10-09). Read-only access means the person narrowed it, or connected before that date. There is no id: a token reads itself only. A session or an API key is a 404 here.

get/connection

Request

  • Base URL: https://api.purplegrain.com/api/v1
  • URL: https://api.purplegrain.com/api/v1/connection
  • Auth: HTTP bearer

Response

The connection, with its grants and the access overview in meta.

Example response

{
  "data": {
    "type": "oauth-token"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.