Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.partneros.ai/llms.txt

Use this file to discover all available pages before exploring further.

The PartnerOS REST API lets you programmatically interact with every major resource in your partner ecosystem. You can create and enrich partner records, manage CRM connections, trigger automations, and invoke the same AI pipelines that power the PartnerOS web application — all over HTTPS using standard JSON payloads.

​
Base URL

All API endpoints are served from: 
https://app.partneros.com/api

​
Making requests

Every request must include the Content-Type: application/json header (except multipart file uploads, which use multipart/form-data). Use the HTTP method specified for each endpoint — GET for reads, POST for creates and actions, and DELETE where supported. 
curl --request GET \
  --url "https://app.partneros.com/api/integrations/{connectionId}/status" \
  --header "Content-Type: application/json" \
  --header "Cookie: <your-session-cookie>"
The PartnerOS API uses session-based authentication via a browser cookie. See the Authentication page for how to obtain a session token and pass it with API requests.

​
Request and response format

Request bodies must be valid JSON. Responses are always JSON objects. Successful responses include the relevant resource data at the top level (for example, { "partner": { ... } } or { "success": true }). Timestamps use ISO 8601 format (2026-05-16T12:00:00.000Z). UUIDs are lowercase with hyphens.

​
Error format

When a request fails, the API returns a JSON object with an error string and, for some errors, a code field with a machine-readable identifier. 
{
  "error": "Partner not found.",
  "code": "not_found"
}
Never expose your session cookie in client-side code or commit it to version control. Treat it with the same care as a private API key.

​
HTTP status codes

CodeMeaning
200Success. The response body contains the requested resource.
202Accepted. The request was enqueued for async processing (e.g. AI generation).
400Bad request. A required field is missing or a value is invalid.
401Unauthorized. Your session is missing or expired.
403Forbidden. Your account does not have permission for this action.
404Not found. The resource does not exist or belongs to a different org.
409Conflict. The operation would create a duplicate (e.g. a template with the same name).
422Unprocessable. The request is valid but a prerequisite is missing (e.g. no ICP on record).
429Rate limited. Slow down and retry after a moment.
500Internal error. Something went wrong on our side.
502Bad gateway. An upstream dependency (AI provider, CRM) returned an error.

​
Rate limiting

The API enforces per-organization, per-user rate limits that vary by endpoint. File upload endpoints (such as partner application banner uploads) allow up to 20 requests per minute per user. AI generation endpoints are subject to your plan’s quota. When you exceed a limit the API returns 429 Too Many Requests.

​
Endpoint groups

GroupBase pathDescription
Partners/api/partnersCreate, enrich, and analyze partner records.
Integrations/api/integrationsConnect CRMs, inspect schemas, and manage sync.
Workflows/api/workflow-pickersList specializations, trainings, and tags used in workflow builders.
AI/api/aiGenerate ICP, IPP, partner types, strategy documents, and chat.
Exports/api/exportsStream PPTX export progress for enablement lessons.
Auth/api/authSession management (sign-in, sign-out, session retrieval).
If you are integrating for the first time, start with Authentication to understand how sessions work, then move on to the Partners API.