Plum / developers
REST APIPipelines

List pipelines

GET/pipelines

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

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

application/json

application/json

curl -X GET "https://example.com/pipelines" \  -H "X-API-Version: 1"
{  "success": true,  "data": {    "items": [      {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "kind": "internal",        "label": "string",        "status": "ready",        "is_default": true,        "created_at": "2019-08-24T14:15:22Z",        "updated_at": "2019-08-24T14:15:22Z"      }    ],    "cursor": "string"  }}

POST /me/sign-out POST

Signs out. With no body, signs out only the calling app: an OAuth caller's grant (its access and refresh tokens) is revoked, or an app session is ended. With `{"everywhere": true}`, which requires account:manage, revokes every OAuth grant for every client and installation, deletes Plum sign-in sessions, revokes every personal access token, and, when called with an app session, signs out every app session. Works for a deleted account. If the access token has expired, refresh it first. Personal access tokens cannot call this endpoint.

Create a pipeline POST

Next Page