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.

​
id
string
required

The unique ID of the account.

​
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

​
credentials
object | null

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

​
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>

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