Skip to content

Commit 56d9818

Browse files
Patching Connect API docs
1 parent 7aef8d0 commit 56d9818

File tree

2 files changed

+6
-17
lines changed

2 files changed

+6
-17
lines changed

docs-v2/pages/connect/api.mdx

Lines changed: 5 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -307,11 +307,6 @@ The ID of the custom [OAuth app](/connect/quickstart#create-a-pipedream-oauth-cl
307307

308308
[The external user ID](/connect/api/#external-users) in your system that you want to retrieve accounts for.
309309

310-
---
311-
312-
`include_credentials` **boolean** (_optional_)
313-
314-
Pass `include_credentials=true` as a query-string parameter to include the account credentials in the response
315310

316311
##### Examples
317312

@@ -331,12 +326,9 @@ const pd = createBackendClient({
331326
projectId: "{your_project_id}"
332327
});
333328

334-
const accounts = await pd.getAccounts({
335-
include_credentials: true, // set to true to include credentials
336-
});
329+
const accounts = await pd.getAccounts();
337330

338-
// Parse and return the data you need. These may contain credentials,
339-
// which you should never return to the client
331+
// Parse and return the data you need
340332
```
341333
</Tabs.Tab>
342334
<Tabs.Tab>
@@ -352,12 +344,9 @@ const pd = createBackendClient({
352344
projectId: "{your_project_id}"
353345
});
354346

355-
const accounts = await pd.getAccounts({
356-
include_credentials: true, // set to true to include credentials
357-
});
347+
const accounts = await pd.getAccounts();
358348

359-
// Parse and return the data you need. These may contain credentials,
360-
// which you should never return to the client
349+
// Parse and return the data you need
361350
```
362351
</Tabs.Tab>
363352
<Tabs.Tab>
@@ -373,7 +362,7 @@ curl -X POST https://api.pipedream.com/v1/oauth/token \
373362

374363
# The response will include an access_token. Use it in the Authorization header below.
375364

376-
curl -X GET "https://api.pipedream.com/v1/connect/{project_id}/accounts/?include_credentials=true" \
365+
curl -X GET "https://api.pipedream.com/v1/connect/{project_id}/accounts" \
377366
-H "Authorization: Bearer {access_token}"
378367
```
379368
</Tabs.Tab>

docs-v2/pages/connect/quickstart.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ When the user connects an account in your product, [pass the token from your bac
116116
In our example, `app/page.tsx` calls the `connectAccount` method from the Pipedream SDK when the user clicks the **Connect your account** button.
117117

118118
<br />
119-
<Image src="https://res.cloudinary.com/pipedreamin/image/upload/v1724182571/connect-account-button-screenshot_n7vjvq.png" alt="Connect your account button" width={550} height={300} />
119+
<Image src="https://res.cloudinary.com/pipedreamin/image/upload/v1733865948/Google_Chrome_-_Pipedream_Connect_Demo_2024-12-10_at_1.23.47_PM_mwxfzh.png" alt="Connect your account button" width={650} height={300} />
120120

121121
```typescript
122122
import { createFrontendClient } from "@pipedream/sdk/browser"

0 commit comments

Comments
 (0)