Partners API — create and manage partner records

The Partners API gives you programmatic control over partner records in your PartnerOS organization. You can trigger AI-powered domain enrichment that populates industry data, employee counts, revenue estimates, and a multi-dimensional fit score. You can also submit partner applications on behalf of prospective partners and upload banner images for application pages. All partner endpoints that read or modify your organization’s data require a valid session. The application submission endpoint (POST /api/partners/applications/submit) is public and does not require authentication, because it is designed to be called by prospective partners filling out your published application form.

Analyze a partner

Runs AI-powered domain analysis on a partner record. The pipeline scrapes and interprets the partner’s web presence to populate enriched fields (industry, description, employees, companyRevenue, regions, languages, services) and computes a multi-dimensional fit score. Results are cached by domain for 7 days to avoid redundant LLM calls. POST /api/partners/{partnerId}/analyze

Path parameters

string

required

UUID of the partner record to analyze. The partner must belong to your active organization.

Response fields

object

required

The updated partner record after enrichment.

Show partner fields

string

UUID of the partner.

string

Organization ID that owns this partner.

string

Partner company name.

string

Partner website domain used for analysis.

string

Industry vertical inferred from the partner’s web presence.

string

AI-generated summary of the partner company.

number

Estimated employee headcount.

number

Estimated annual revenue in USD.

string[]

Geographic regions where the partner operates.

string[]

Languages supported by the partner.

string[]

Service categories the partner offers.

number

Overall partner fit score (0–100).

string

Partner tier classification: platinum, gold, silver, bronze, or registered.

string

Partner status: active, inactive, or pending.

string

Lifecycle stage: prospect, onboarding, active, scaling, qualified, legal_negotiation, signed, enabled, activated, or rejected.

string

ISO 8601 timestamp of record creation.

string

ISO 8601 timestamp of last update.

object

required

Dimensional breakdown of the AI fit assessment.

Show aiInsights fields

number

Composite fit score (0–100).

number

Score for the partner’s available bandwidth to take on new business (0–100).

number

Score for technical and service delivery competency (0–100).

number

Score for demonstrated commitment to the partnership (0–100).

number

Score for alignment with your ICP (0–100).

string

Narrative summary of the partner’s fit.

string[]

List of key strengths identified by the analysis.

string

ISO 8601 timestamp of when the analysis ran.

Example

curl --request POST \
  --url "https://app.partneros.com/api/partners/3f2e1d4c-89ab-4cde-8f01-123456789abc/analyze" \
  --header "Content-Type: application/json" \
  --header "Cookie: session_token=<your-session-token>"

{
  "partner": {
    "id": "3f2e1d4c-89ab-4cde-8f01-123456789abc",
    "orgId": "org_01hx...",
    "name": "Acme Consulting",
    "domain": "acmeconsulting.io",
    "industry": "Enterprise Software Consulting",
    "description": "Acme Consulting specializes in cloud migration and SaaS implementation services for mid-market technology companies across North America.",
    "employees": 120,
    "companyRevenue": 18000000,
    "regions": ["North America", "Western Europe"],
    "languages": ["English", "French"],
    "services": ["Cloud Migration", "SaaS Implementation", "Change Management"],
    "fitScore": 84,
    "tier": "gold",
    "status": "active",
    "stage": "active",
    "createdAt": "2026-01-10T08:00:00.000Z",
    "updatedAt": "2026-05-16T11:42:00.000Z"
  },
  "aiInsights": {
    "overallFitScore": 84,
    "capacity": 78,
    "capability": 91,
    "commitment": 82,
    "customerAlignment": 88,
    "summary": "Acme Consulting is a strong fit with demonstrated enterprise SaaS expertise and a customer base that closely matches your ICP. Their mid-market focus and active partnership programs indicate high commitment.",
    "keyStrengths": [
      "Deep SaaS implementation experience",
      "Established mid-market customer base",
      "Active partner community involvement"
    ],
    "analyzedAt": "2026-05-16T11:42:00.000Z"
  }
}

If the partner record has no domain set, the analysis runs on company name alone and may produce lower-confidence results. Set a domain on the partner record before triggering analysis for best results.

Submit a partner application

Accepts a public partner application submission. This endpoint is unauthenticated and is intended to be called from your published partner application form. You must provide the application’s public slug and valid form data that satisfies all required fields and agreements defined in the application builder. POST /api/partners/applications/submit

Body parameters

string

required

Public slug identifier of the partner application form. Found in your application’s share settings.

object

required

Key-value map of field responses. Keys are the fieldKey values defined in the application builder. Values are strings (use "true" for checkbox fields that are checked).

string[]

required

Array of agreement section IDs that the applicant has accepted. Required agreements must be present or the submission is rejected.

string

Optional affiliate tracking slug. When provided, the submission is attributed to the corresponding affiliate link and the link’s lead count is incremented.

string

Cloudflare Turnstile verification token. Required in production to prevent automated submissions.

Response fields

boolean

required

true when the submission was accepted and recorded.

string

Custom confirmation message configured in the application’s content settings, displayed to the applicant after submission.

Example

curl --request POST \
  --url "https://app.partneros.com/api/partners/applications/submit" \
  --header "Content-Type: application/json" \
  --data '{
    "slug": "acme-partner-application",
    "submissionData": {
      "company_name": "Bright Solutions Ltd",
      "company_website": "https://brightsolutions.example",
      "contact_name": "Jane Smith",
      "contact_email": "jane@brightsolutions.example",
      "years_in_business": "8",
      "partner_type": "consulting",
      "agree_to_nda": "true"
    },
    "agreedSections": ["nda-section", "terms-section"],
    "turnstileToken": "0.XXXX..."
  }'

{
  "success": true,
  "successMessage": "Thank you for applying! Our team will review your application and be in touch within 3 business days."
}

The application must have a publishState of "published" and isPublic set to true in its share settings. Submissions to unpublished or private applications return 404 Not Found.

Uploads a banner image for a partner application page. A public URL is returned for use in the application builder. POST /api/partners/applications/banner Accepts multipart/form-data. Requires authentication.

Form fields

file

required

The image file to upload. Accepted formats: JPEG, PNG, WebP, GIF. Maximum size: 5 MB.

Response fields

string

required

Storage path of the uploaded image within the banner bucket.

string

required

Publicly accessible URL of the uploaded banner image.

string

required

Always "supabase".

Example

curl --request POST \
  --url "https://app.partneros.com/api/partners/applications/banner" \
  --header "Cookie: session_token=<your-session-token>" \
  --form "file=@/path/to/banner.png"

{
  "bannerImagePath": "org_01hx.../usr_01hx.../banner-1747389720000.png",
  "bannerImageUrl": "https://cdn.supabase.co/storage/v1/object/public/partner-application-banners/org_01hx.../usr_01hx.../banner-1747389720000.png",
  "storageProvider": "supabase"
}

This endpoint enforces a rate limit of 20 uploads per minute per user per organization. Exceeding this limit returns 429 Too Many Requests.

Upload a legal template

Uploads a PDF legal template to Docuseal and records it as a reusable or one-off agreement template for a specific partner. Requires authentication and a non-partner role. POST /api/partners/legal-templates Accepts multipart/form-data.

Form fields

file

required

The PDF document to use as the agreement template. Only PDF files are accepted.

string

required

UUID of the partner this template is associated with.

string

required

Display name of the template. Must be unique within your organization (case-insensitive).

string

Optional description of the template’s purpose.

string

required

Template scope: "reusable" (available for multiple agreements) or "one_off" (single-use).

string

required

JSON-encoded array of field placement objects that define where signature, date, and other fields appear on the PDF pages.

string

required

JSON-encoded array of signer role names (e.g. ["Partner", "PartnerOS"]).

Response fields

boolean

required

true when the template was created successfully.

object

required

The newly created legal template record.

Show template fields

string

UUID of the template record.

string

Organization that owns this template.

string

UUID of the associated partner.

string

Template display name.

string

"reusable" or "one_off".

string

Always "docuseal".

number

Docuseal template ID for API reference.

string

Original filename of the uploaded PDF.

string[]

Signer role names.

Example

curl --request POST \
  --url "https://app.partneros.com/api/partners/legal-templates" \
  --header "Cookie: session_token=<your-session-token>" \
  --form "file=@/path/to/partner-nda.pdf" \
  --form "partnerId=3f2e1d4c-89ab-4cde-8f01-123456789abc" \
  --form "name=Standard Partner NDA 2026" \
  --form "description=Mutual non-disclosure agreement for new partners" \
  --form 'scope=reusable' \
  --form 'fieldPlacements=[{"name":"Signature","type":"signature","role":"Partner","required":true,"page":1,"x":0.1,"y":0.8,"w":0.3,"h":0.05}]' \
  --form 'roleDefinitions=["Partner","PartnerOS"]'

{
  "success": true,
  "template": {
    "id": "tmpl_01hx...",
    "orgId": "org_01hx...",
    "partnerId": "3f2e1d4c-89ab-4cde-8f01-123456789abc",
    "name": "Standard Partner NDA 2026",
    "description": "Mutual non-disclosure agreement for new partners",
    "scope": "reusable",
    "docsignProvider": "docuseal",
    "docusealTemplateId": 48291,
    "sourceDocumentName": "partner-nda.pdf",
    "roleDefinitions": ["Partner", "PartnerOS"],
    "fieldPlacements": [
      {
        "name": "Signature",
        "type": "signature",
        "role": "Partner",
        "required": true,
        "page": 1,
        "x": 0.1,
        "y": 0.8,
        "w": 0.3,
        "h": 0.05
      }
    ]
  }
}

If a template with the same name already exists in your organization, the API returns 409 Conflict with the existing template’s details in an existing field. Use the existing template or choose a different name.

Overview

Endpoints

Partners API — create and manage partner records

Analyze a partner

Path parameters

Response fields

Example

Submit a partner application

Body parameters

Response fields

Example

Upload an application banner image

Form fields

Response fields

Example

Upload a legal template

Form fields

Response fields

Example

​Analyze a partner

​Path parameters

​Response fields

​Example

​Submit a partner application

​Body parameters

​Response fields

​Example

​Upload an application banner image

​Form fields

​Response fields

​Example

​Upload a legal template

​Form fields

​Response fields

​Example

Analyze a partner

Path parameters

Response fields

Example

Submit a partner application

Body parameters

Response fields

Example

Upload an application banner image

Form fields

Response fields

Example

Upload a legal template

Form fields

Response fields

Example