Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

A short-lived OAuth access token for server-side requests. Generate one via the Generate OAuth Token flow or automatically when initializing the SDK client.

Path Parameters

project_id
string
required

The project ID, which starts with proj_.

Pattern: ^proj_[a-zA-Z0-9]+$
id
string
required

The OAuth client ID, which starts with oa_.

Pattern: ^oa_[0-9A-Za-z]+$

Response

OAuth client retrieved

An OAuth client, either a custom client (bring your own app) or a Pipedream official client, presented as its app's metadata merged with the client's own fields. name and description fall back to the app's when the client doesn't set them. The client secret is write-only and never returned.

id
string
required

Hash ID for the OAuth client

Pattern: ^oa_[0-9A-Za-z]+$
name_slug
string
required
name
string
required

The human-readable name of the app

img_src
string
required

The URL to the app's logo

custom_fields_json
string | null
required

A JSON string representing the custom fields for the app

categories
string[]
required

Categories associated with the app

A rough directional ordering of app popularity, subject to changes by Pipedream

scope_profiles
object[]
required

Named subsets of the app's OAuth scopes that may be requested when users connect their accounts (via the oauth_scope_profile parameter). Empty for apps that don't define any.

client_id
string | null
required

The OAuth client ID registered with the upstream provider. Null for a client registered before its provider issued credentials.

owner_id
string | null
required

Hash ID of the owner: the workspace (o_...) or the project (proj_...). Null for Pipedream official clients.

auth_type
enum<string> | null

The authentication type used by the app

Available options:
keys,
oauth,
none
description
string | null

A short description of the app

oauth_app_id
string | null

ID of the app's Pipedream official OAuth client, or null if the app doesn't use OAuth or has no official client. Useful for retrieving the OAuth client's client_id and redirect URI with the Retrieve OAuth client endpoint.

scopes
string[] | null

The OAuth scopes requested when an account connects through this OAuth client, or, on an app, through the app's Pipedream official OAuth client and no oauth_scope_profile. null when the app doesn't use OAuth or has no official client. Absent when the app is embedded in another resource, such as an account.

additional_scopes
string[] | null

A second list of scopes requested alongside scopes. The connection does not require the user to grant them. scope_labels names both lists. null when there are none, or when the app doesn't use OAuth or has no official client. Absent when the app is embedded in another resource, such as an account.

scope_labels
object | null

Display names for scopes and additional_scopes; their meaning depends on the app. null when the app doesn't use OAuth or has no official client. Absent when the app is embedded in another resource, such as an account.

redirect_uri
string

The redirect URI to register with the upstream OAuth provider

created_at
string<date-time>
updated_at
string<date-time>