Dynamiq
End User Requirements

List requirements

Lists the end-user requirements of the app the connect token is scoped to — the connection and action connector account requirements referenced by the app's deployed workflow version. Served on the management API; authenticate with a connect token.

GET
/v1/connect/requirements

Authorization

connectToken
AuthorizationBearer <token>

Short-lived Connect token identifying a single end user of a single app. Created with POST /v1/connect/tokens on the deployed app's hostname and valid for 24 hours. Accepted only by the /v1/connect/* requirement-fulfillment endpoints on the management API — it is distinct from Access Keys and Personal Access Tokens and grants no other API access. Send as Authorization: Bearer <connect-token>.

In: header

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v1/connect/requirements"
{
  "data": [
    {
      "id": "9b8e2f4d-1c3a-4d5e-8f60-718293a4b5c6",
      "type": "pipedream_account",
      "title": "Connect your Gmail account",
      "description": "Used to send triage replies on your behalf.",
      "spec": {
        "type": "pipedream_account",
        "data": {
          "app_slug": "gmail"
        }
      }
    },
    {
      "id": "5e4d3c2b-1a09-4f8e-9d7c-6b5a43210fed",
      "type": "connection",
      "title": "Helpdesk API key",
      "description": "Read-only access to your helpdesk tickets.",
      "spec": {
        "type": "connection",
        "data": {
          "type": "dynamiq.connections.HttpApiKey"
        }
      }
    }
  ]
}
{
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}
{
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

Create a connect token

Creates a short-lived **connect token** for an end user of the app. The token is a bearer JWT scoped to this app and this user, valid for **24 hours**, and is the credential accepted by the `/v1/connect/*` requirement-fulfillment endpoints on the management API — it is distinct from Access Keys and Personal Access Tokens. The response also includes the URL of the hosted connect page, pre-filled with the token, where the end user can fulfill the requirements in a browser. The app is identified by the hostname. Private apps require an Access Key; public apps can be called without credentials.

Get requirement statuses

Lists the end-user requirements of the app the connect token is scoped to, with a per-requirement `status` for the token's user: `completed` when the user has an active connection or a linked action connector account for the requirement, `pending` otherwise. Served on the management API; authenticate with a connect token.