API Integrations Overview
How the documented API and built-in integrations map to the actual product. Learn the workflows, permissions, screenshots, and related setup guidance in the…
API Integrations Overview
Authentication
The API uses bearer authentication.
- Use an Admin Center session in the browser, or
- Create an API key from Integrations & API Keys and send it as
Authorization: Bearer ...
What The API Covers
The /docs/api/v1 reference is generated from the OpenAPI files and documents endpoints for areas such as:
- Accounts
- Contacts
- Documents
- Certifications
- Access requests
- Knowledge base entries
- Users
- Custom tabs
- NDA templates
- Analytics
- Built-in integrations
Built-In Integration APIs
The integration endpoints in the reference are for the integrations that are implemented in the product:
- Google Docs / Google Drive
- Notion
- Confluence
- Slack
- DocuSign
These endpoints support the Admin Center UI and shipped product flows.
Example
Use standard HTTP clients such as curl or fetch.
curl -X GET "https://app.orbiqhq.com/api/v1/documents" \
-H "Authorization: Bearer $ACCESS_TOKEN"const response = await fetch("https://app.orbiqhq.com/api/v1/documents", {
headers: {
Authorization: `Bearer ${process.env.ACCESS_TOKEN}`,
},
});
if (!response.ok) {
throw new Error(await response.text());
}
const payload = await response.json();
console.log(payload);Important Notes
- Slack and DocuSign endpoints are for the shipped integrations, not for arbitrary third-party webhook setups
Related Docs
How is this guide?