List accounts

cURL

curl --request GET \
  --url https://api.pipedream.com/v1/connect/{project_id}/accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'x-pd-environment: <x-pd-environment>'

{
  "data": [
    {
      "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,
        "id": "<string>",
        "auth_type": "keys",
        "description": "<string>"
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "credentials": {},
      "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"
    }
  ],
  "page_info": {
    "count": 123,
    "total_count": 123,
    "start_cursor": "<string>",
    "end_cursor": "<string>"
  }
}

GET

connect

{project_id}

accounts

cURL

curl --request GET \
  --url https://api.pipedream.com/v1/connect/{project_id}/accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'x-pd-environment: <x-pd-environment>'

{
  "data": [
    {
      "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,
        "id": "<string>",
        "auth_type": "keys",
        "description": "<string>"
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "credentials": {},
      "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"
    }
  ],
  "page_info": {
    "count": 123,
    "total_count": 123,
    "start_cursor": "<string>",
    "end_cursor": "<string>"
  }
}

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

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

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_.

Query Parameters

after

string

The cursor to start from for pagination

before

string

The cursor to end before for pagination

limit

integer

The maximum number of results to return

app

string

The app slug or ID to filter accounts by.

include_credentials

boolean

Whether to retrieve the account's credentials or not

external_user_id

string

oauth_app_id

string

The OAuth app ID to filter by, if applicable

Response

accounts listed

Response received when listing accounts

data

object[]

required

Show child attributes

data.id

string

required

The unique ID of the account.

data.name

string | null

The custom name of the account if set.

data.external_id

string

The external ID associated with the account.

data.healthy

boolean

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

data.dead

boolean | null

Indicates if the account is no longer active

data.app

object

Response object for a Pipedream app's metadata

Show child attributes

data.app.name_slug

string

required

The name slug of the target app (see https://pipedream.com/docs/connect/quickstart#find-your-apps-name-slug)

data.app.name

string

required

The human-readable name of the app

data.app.img_src

string

required

The URL to the app's logo

data.app.custom_fields_json

string | null

required

A JSON string representing the custom fields for the app

data.app.categories

string[]

required

Categories associated with the app

data.app.featured_weight

number

required

A rough directional ordering of app popularity, subject to changes by Pipedream

data.app.id

string | null

ID of the app. Only applies for OAuth apps.

data.app.auth_type

enum<string> | null

The authentication type used by the app

Available options:

keys,

oauth,

none

data.app.description

string | null

A short description of the app

data.created_at

string<date-time>

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

data.updated_at

string<date-time>

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

data.credentials

object

The credentials associated with the account, if the include_credentials parameter was set to true in the request

data.expires_at

string<date-time>

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

data.error

string | null

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

data.last_refreshed_at

string<date-time>

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

data.next_refresh_at

string<date-time> | null

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

page_info

object

required

Show child attributes

page_info.count

integer

page_info.total_count

integer

page_info.start_cursor

string

page_info.end_cursor

string

List app categories Retrieve account

⌘I

Tokens

Apps

Accounts

Components

Actions

Triggers

Component Configuration

Deployed Triggers

Manage Projects

Authorizations

Headers

Path Parameters

Query Parameters

Response