GET
/
v1
/
connect
/
{project_id}
/
accounts
/
{account_id}
cURL
curl --request GET \
  --url https://api.pipedream.com/v1/connect/{project_id}/accounts/{account_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-pd-environment: <x-pd-environment>'
{
  "id": "<string>",
  "name": "<string>",
  "external_id": "<string>",
  "healthy": true,
  "dead": true,
  "app": {
    "id": "<string>",
    "name_slug": "<string>",
    "name": "<string>",
    "auth_type": "keys",
    "description": "<string>",
    "img_src": "<string>",
    "custom_fields_json": "<string>",
    "categories": [
      "<string>"
    ],
    "featured_weight": 123
  },
  "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"
}
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

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

account_id
string
required

Query Parameters

include_credentials
boolean

Whether to retrieve the account's credentials or not

Response

200 - application/json

account retrieved

End user account data, returned from the API.