PIpipedream

Retrieve account

Changed on

Get the details for a specific connected account

get/v1/connect/{project_id}/accounts/{account_id}

Request

  • Base URL
    https://api.pipedream.com
  • URL
    https://api.pipedream.com/v1/connect/{project_id}/accounts/{account_id}
  • Auth
    • HTTP bearer
    • or OAuth 2
      Client credentials
      Token URL: https://api.pipedream.com/v1/oauth/token

Query parameters

include_credentialsboolean

Whether to retrieve the account's credentials or not

Headers

x-pd-environment'development' | 'production' required

The environment in which the server client is running

Response

account retrieved

idstring required

The unique ID of the account.

namestring nullable

The custom name of the account if set.

external_idstring

The external ID associated with the account.

healthyboolean

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

deadboolean nullable

Indicates if the account is no longer active

created_atstring date-time

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

updated_atstring date-time

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

authorized_scopesstring[]

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

expires_atstring date-time

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

errorstring nullable

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

last_refreshed_atstring date-time nullable

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

next_refresh_atstring date-time nullable

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

Changes

  • b5c4b07064c6Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • 5bf041f14074Revision changes
    • info

      added the optional property / to the response with the status