Skip to main content
GET
/
v1
/
connect
/
{project_id}
/
users
/
{external_user_id}
/
accounts
cURL
curl --request GET \
  --url https://api.pipedream.com/v1/connect/{project_id}/users/{external_user_id}/accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'x-pd-environment: <x-pd-environment>'
[
  {
    "id": "<string>",
    "name": "<string>",
    "external_id": "<string>",
    "healthy": true,
    "dead": true,
    "app": {
      "name_slug": "<string>",
      "name": "<string>",
      "img_src": "<string>",
      "custom_fields_json": "<string>",
      "categories": [
        "<string>"
      ],
      "featured_weight": 123,
      "scope_profiles": [
        {
          "scopes": [
            "<string>"
          ]
        }
      ],
      "id": "<string>",
      "description": "<string>"
    },
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "authorized_scopes": [
      "<string>"
    ],
    "credentials": {
      "oauth_client_id": "<string>",
      "oauth_access_token": "<string>",
      "oauth_refresh_token": "<string>",
      "oauth_uid": "<string>",
      "oauth_signer_uri": "<string>"
    },
    "expires_at": "2023-11-07T05:31:56Z",
    "error": "<string>",
    "last_refreshed_at": "2023-11-07T05:31:56Z",
    "next_refresh_at": "2023-11-07T05:31:56Z"
  }
]

Documentation Index

Fetch the complete documentation index at: https://pipedream.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

To retrieve credentials for OAuth apps (Slack, Google Sheets, etc), the connected account must be using your own OAuth client.
Never return user credentials to the client

Authorizations

​
Authorization
string
header
required

A short-lived Connect token for client-side requests on behalf of an end user. Generate one via the Create Connect token endpoint.

Headers

​
x-pd-environment
enum<string>
required

The environment in which the server client is running

Available options:
development,
production

Path Parameters

​
project_id
string
required

The project ID, which starts with proj_.

Pattern: ^proj_[a-zA-Z0-9]+$
​
external_user_id
string
required

Query Parameters

​
include_credentials
boolean
​
app
string

Response

accounts listed

​
id
string
required

The unique ID of the account.

Pattern: ^apn_[a-zA-Z0-9]+$
​
name
string | null

The custom name of the account if set.

​
external_id
string

The external ID associated with the account.

​
healthy
boolean

Indicates if the account is healthy. Pipedream will periodically retry token refresh and test requests for unhealthy accounts

​
dead
boolean | null

Indicates if the account is no longer active

​
app
object

Response object for a Pipedream app's metadata

​
created_at
string<date-time>

The date and time the account was created, an ISO 8601 formatted string

​
updated_at
string<date-time>

The date and time the account was last updated, an ISO 8601 formatted string

​
authorized_scopes
string[]

The OAuth scopes effectively granted to this account. Empty for non-OAuth apps.

​
credentials
object

The credentials associated with the account, if the include_credentials parameter was set to true in the request (only applicable for BYOA apps). In addition to the well-known OAuth fields listed below, this object may contain app-specific custom fields (e.g. base_url).

​
expires_at
string<date-time>

The date and time the account's credentials expiration, an ISO 8601 formatted string

​
error
string | null

The error message if the account is unhealthy or dead, null otherwise

​
last_refreshed_at
string<date-time> | null

The date and time the account was last refreshed, an ISO 8601 formatted string

​
next_refresh_at
string<date-time> | null

The date and time the account will next be refreshed, an ISO 8601 formatted string