Plum / developers
REST APIUser

List connected apps

Lists the apps connected to your account, newest first: one item per OAuth grant. Each installation of an Optima app is its own connection; a third-party app has one. `current` marks the grant of the calling app. Uses the usual `limit` and `cursor` pagination. Personal access tokens cannot call this endpoint.

GET/me/connections

Authorization

bearerAuth
AuthorizationBearer <token>

Send Authorization: Bearer <token> with one of: an app session access token from /auth/verify-otp or /auth/refresh; an OAuth access token from /oauth/token issued for the API origin (its scopes are its permissions); or a personal access token starting with optima_pat_ (see /docs/personal-access-tokens). Personal access tokens cannot create or list tokens, revoke other tokens, sign out, or delete or restore the account. Content routes need the permission of their layer: audio:read/audio:write for recordings, turns:read/turns:write for turns, contacts, source signals, and events, and insights:read/insights:write for suggestions and session summaries; search and recall need turns:read and insights:read. A request without the permission, or for an account whose layer is turned off, returns 403 FORBIDDEN. See /docs/authentication#scopes.

In: header

Query Parameters

limit?integer
Range1 <= value <= 100
Default25
cursor?string
Lengthlength <= 512

Header Parameters

X-API-Version?"1"

Send 1 to pin the documented API contract. If omitted, the latest version is selected.

Default"1"

Value in

  • "1"

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/me/connections" \  -H "X-API-Version: 1"
{  "success": true,  "data": {    "items": [      {        "id": "string",        "client_id": "string",        "name": "string",        "scopes": [          "string"        ],        "created_at": "2019-08-24T14:15:22Z",        "current": true      }    ],    "cursor": "string"  }}

Delete your account DELETE

Deletes the account. The credential must come from an email-code sign-in in the last 10 minutes; otherwise the request is refused with 403 REAUTHENTICATION_REQUIRED, and the client signs in again and retries. The deletion takes effect at once, and the account and its data are erased 7 days later unless it is restored first; an email to the account says when.

Disconnect an app DELETE

Disconnects one app: revokes its OAuth grant with its access and refresh tokens, so the app must sign in again. Other apps stay connected. Disconnecting the calling app (`current`) ends its own access. To disconnect every app, sign out everywhere with `POST /me/sign-out`. Personal access tokens cannot call this endpoint.