Admin — partners

6 endpoints in this group. All paths are prefixed with /api/v1.

Endpoints in this group#

• GET /api/v1/admin/partners — List Partners
• POST /api/v1/admin/partners — Create Partner
• GET /api/v1/admin/partners/known — List Known Partners
• DELETE /api/v1/admin/partners/{partner_id} — Delete Partner
• GET /api/v1/admin/partners/{partner_id} — Get Partner
• PUT /api/v1/admin/partners/{partner_id} — Update Partner

GET /api/v1/admin/partners — List Partners {#get-api-v1-admin-partners}#

List all partners — both configured and discovered from synced users.

Parameters:

• authorization (header, string, optional)

Responses:

• 200 — Successful Response. Returns: ApiResponse_list_PartnerResponse__ — {data, meta}
• 422 — Validation Error. Returns: HTTPValidationError — {detail}

POST /api/v1/admin/partners — Create Partner {#post-api-v1-admin-partners}#

Create a new partner configuration.

Parameters:

• authorization (header, string, optional)

Body: PartnerCreateRequest — {partner_id, partner_name, billing_model, commission_rate + 6 more}

Responses:

• 201 — Successful Response. Returns: ApiResponse_PartnerResponse_ — {data, meta}
• 422 — Validation Error. Returns: HTTPValidationError — {detail}

GET /api/v1/admin/partners/known — List Known Partners {#get-api-v1-admin-partners-known}#

List all partner_ids discovered from synced users.

Parameters:

• authorization (header, string, optional)

Responses:

• 200 — Successful Response. Returns: ApiResponse_list_KnownPartner__ — {data, meta}
• 422 — Validation Error. Returns: HTTPValidationError — {detail}

DELETE /api/v1/admin/partners/{partner_id} — Delete Partner {#delete-api-v1-admin-partners-partner-id}#

Delete a partner configuration.

Parameters:

• partner_id (path, string, required)
• authorization (header, string, optional)

Responses:

• 200 — Successful Response. Returns: ApiResponse_dict_ — {data, meta}
• 422 — Validation Error. Returns: HTTPValidationError — {detail}

GET /api/v1/admin/partners/{partner_id} — Get Partner {#get-api-v1-admin-partners-partner-id}#

Get a single partner configuration.

Parameters:

• partner_id (path, string, required)
• authorization (header, string, optional)

Responses:

• 200 — Successful Response. Returns: ApiResponse_PartnerResponse_ — {data, meta}
• 422 — Validation Error. Returns: HTTPValidationError — {detail}

PUT /api/v1/admin/partners/{partner_id} — Update Partner {#put-api-v1-admin-partners-partner-id}#

Update a partner configuration.

Parameters:

• partner_id (path, string, required)
• authorization (header, string, optional)

Body: PartnerUpdateRequest — {partner_name, billing_model, commission_rate, allowed_services + 16 more}

Responses:

• 200 — Successful Response. Returns: ApiResponse_PartnerResponse_ — {data, meta}
• 422 — Validation Error. Returns: HTTPValidationError — {detail}