Skip to main content
GET
/
v1
/
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": 10,
    "total_count": 120,
    "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

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

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
​
page_info
object
required