const listResponse = await fetch(
`https://api.joinoverlap.com/workflows?companyId=${process.env.OVERLAP_COMPANY_ID}`,
{
headers: {
"Authorization": `Bearer ${process.env.OVERLAP_API_KEY}`
}
}
);
const workflows = await listResponse.json();
curl "https://api.joinoverlap.com/workflows?companyId=$OVERLAP_COMPANY_ID" \
-H "Authorization: Bearer $OVERLAP_API_KEY"
curl "https://api.joinoverlap.com/workflow?companyId=$OVERLAP_COMPANY_ID&workflowId=$OVERLAP_WORKFLOW_ID" \
-H "Authorization: Bearer $OVERLAP_API_KEY"
Workflows
List workflow summaries and retrieve a saved workflow definition
GET
/
workflows
const listResponse = await fetch(
`https://api.joinoverlap.com/workflows?companyId=${process.env.OVERLAP_COMPANY_ID}`,
{
headers: {
"Authorization": `Bearer ${process.env.OVERLAP_API_KEY}`
}
}
);
const workflows = await listResponse.json();
curl "https://api.joinoverlap.com/workflows?companyId=$OVERLAP_COMPANY_ID" \
-H "Authorization: Bearer $OVERLAP_API_KEY"
curl "https://api.joinoverlap.com/workflow?companyId=$OVERLAP_COMPANY_ID&workflowId=$OVERLAP_WORKFLOW_ID" \
-H "Authorization: Bearer $OVERLAP_API_KEY"
List Workflows
GET https://api.joinoverlap.com/workflows?companyId={companyId}
id, name, and description.
Authentication
Authorization: Bearer YOUR_API_KEY
Query Parameters
| Parameter | Required | Description |
|---|---|---|
companyId | Yes | Your Overlap company or organization identifier. |
The same lookup is also available at
GET /companies/{companyId}/workflows.Response
{
"workflows": [
{
"id": "workflow-id",
"name": "Webinar Clips",
"description": "Finds and formats highlights from webinar recordings."
}
]
}
Get Workflow
GET https://api.joinoverlap.com/workflow?companyId={companyId}&workflowId={workflowId}
Query Parameters
| Parameter | Required | Description |
|---|---|---|
companyId | Yes | Your Overlap company or organization identifier. |
workflowId | Yes | The saved workflow id. |
The same lookup is also available at
GET /companies/{companyId}/workflows/{workflowId}.Response
{
"workflow": {
"id": "workflow-id",
"name": "Webinar Clips",
"description": "Finds and formats highlights from webinar recordings.",
"nodes": [],
"edges": []
}
}
const listResponse = await fetch(
`https://api.joinoverlap.com/workflows?companyId=${process.env.OVERLAP_COMPANY_ID}`,
{
headers: {
"Authorization": `Bearer ${process.env.OVERLAP_API_KEY}`
}
}
);
const workflows = await listResponse.json();
curl "https://api.joinoverlap.com/workflows?companyId=$OVERLAP_COMPANY_ID" \
-H "Authorization: Bearer $OVERLAP_API_KEY"
curl "https://api.joinoverlap.com/workflow?companyId=$OVERLAP_COMPANY_ID&workflowId=$OVERLAP_WORKFLOW_ID" \
-H "Authorization: Bearer $OVERLAP_API_KEY"
Was this page helpful?