Ryan/documenso
1
0
Fork 1
mirror of https://github.com/documenso/documenso.git synced 2026-08-24 23:32:29 +10:00
Code Issues Packages Projects Releases Wiki Activity

docs(api): filter team document lists by type

Browse Source 
GET /envelope without type returns templates as well as documents; add type=DOCUMENT
to every document-list example so counts and results match the prose
This commit is contained in:
ephraimduncan
2026-07-30 22:04:01 +00:00
parent eeae0e1e02
commit f353706e24
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
apps/docs/content/docs/developers/api/teams.mdx
+5 -5
View File
@@ -141,18 +141,18 @@ Retrieve all documents belonging to the team:
<Tab value="curl"> <Tab value="curl">
```bash ```bash
# List all team documents # List all team documents
curl -X GET "https://app.documenso.com/api/v2/envelope" \ curl -X GET "https://app.documenso.com/api/v2/envelope?type=DOCUMENT" \
-H "Authorization: api_team_xxxxxxxxxxxxxxxx" -H "Authorization: api_team_xxxxxxxxxxxxxxxx"
# Filter by status # Filter by status
curl -X GET "https://app.documenso.com/api/v2/envelope?status=PENDING" \ curl -X GET "https://app.documenso.com/api/v2/envelope?type=DOCUMENT&status=PENDING" \
-H "Authorization: api_team_xxxxxxxxxxxxxxxx" -H "Authorization: api_team_xxxxxxxxxxxxxxxx"
```` ````
</Tab> </Tab>
<Tab value="TypeScript"> <Tab value="TypeScript">
```typescript ```typescript
const response = await fetch('https://app.documenso.com/api/v2/envelope', { const response = await fetch('https://app.documenso.com/api/v2/envelope?type=DOCUMENT', {
method: 'GET', method: 'GET',
headers: { headers: {
Authorization: TEAM_API_TOKEN, Authorization: TEAM_API_TOKEN,
@@ -317,13 +317,13 @@ const SALES_TEAM_TOKEN = process.env.SALES_TEAM_API_TOKEN;
const LEGAL_TEAM_TOKEN = process.env.LEGAL_TEAM_API_TOKEN; const LEGAL_TEAM_TOKEN = process.env.LEGAL_TEAM_API_TOKEN;
// Get pending documents from sales team // Get pending documents from sales team
const salesResponse = await fetch('https://app.documenso.com/api/v2/envelope?status=PENDING', { const salesResponse = await fetch('https://app.documenso.com/api/v2/envelope?type=DOCUMENT&status=PENDING', {
headers: { Authorization: SALES_TEAM_TOKEN }, headers: { Authorization: SALES_TEAM_TOKEN },
}); });
const salesDocs = await salesResponse.json(); const salesDocs = await salesResponse.json();
// Get completed documents from legal team // Get completed documents from legal team
const legalResponse = await fetch('https://app.documenso.com/api/v2/envelope?status=COMPLETED', { const legalResponse = await fetch('https://app.documenso.com/api/v2/envelope?type=DOCUMENT&status=COMPLETED', {
headers: { Authorization: LEGAL_TEAM_TOKEN }, headers: { Authorization: LEGAL_TEAM_TOKEN },
}); });
const legalDocs = await legalResponse.json(); const legalDocs = await legalResponse.json();