Account
Connected account (external user's OAuth connection to an app)
Usage profiles
| Usage | Fields and validation |
|---|---|
| In responses | View fields |
In responses
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
id | string | Optional | Unique account ID. |
name | string | Optional | Display name (e.g., user's email or handle). |
externalUserId | string | Optional | Your application's user ID. |
healthy | boolean | Optional | Whether the account credentials are valid. |
app | string | Optional | Pipedream application selected by the request or returned by the provider. |
oauthAppId | string | Optional | OAuth app identifier (if applicable). |
createdAt | string (date-time) | Optional | Time when this record was created. |
updatedAt | string (date-time) | Optional | Time when this record was last updated. |
credentialsLastRefreshedAt | string (date-time) | Optional | Time when the connected account credentials were last refreshed. |
credentialsExpiresAt | string (date-time) | Optional | Expiration time reported for the connected account credentials. |
error | string | Optional | Error message if unhealthy. |
lastRefreshedAt | string (date-time) | Optional | ISO 8601 when credentials were last refreshed. |
nextRefreshAt | string (date-time) | Optional | ISO 8601 when credentials will next be refreshed. |
Where used
| Reference | Relationship |
|---|---|
| List the caller's connected accounts | POST /api/v1/integrations/pipedream/list-accounts |
Download the public reference contract.
Document: DOC-API-MODEL-account.