Skip to main content

Retrieve one app by slug

POST 

/api/v1/integrations/pipedream/retrieve-app

Returns a single app by its nameSlug — the stable identifier used everywhere else in this API (github, slack, google_calendar). Use it to render an app detail page without paging the whole catalog.

The following access conditions are preserved as declared intent and are not implemented by generated code: Authorized shared platform action.

Use this in a guide: Let your assistant answer questions about a customer’s calendar

Request​

Responses​

The app

Look up the GitHub app before starting a connection.​

Section ID: DOC-IN-tools-connections-apps-api-pipedreamRetrieveApp#example-connected-apps-pipedreamRetrieveApp-request

Request example

{
"nameSlug": "github"
}

Illustrative response shape; omitted default fields and actual outcomes depend on the operation.​

Section ID: DOC-IN-tools-connections-apps-api-pipedreamRetrieveApp#example-connected-apps-pipedreamRetrieveApp-response

Response example

{
"app": {
"id": "example_123",
"nameSlug": "example",
"name": "example",
"authType": "AUTH_TYPE_KEYS",
"description": "example",
"imgSrc": "example",
"customFieldsJson": "{}",
"categories": [
"example"
],
"featuredWeight": 1
}
}

Document ID: DOC-IN-tools-connections-apps-api-pipedreamRetrieveApp. Section identities and revisions.

SectionStable reference
Retrieve one app by slugDOC-IN-tools-connections-apps-api-pipedreamRetrieveApp#overview
RequestDOC-IN-tools-connections-apps-api-pipedreamRetrieveApp#request
ResponsesDOC-IN-tools-connections-apps-api-pipedreamRetrieveApp#responses