Ctrlk
StatusBack to peakcommerce.com
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Partners

Add an overview of the Admin - Partners API here. This block is preserved across regenerations.

Endpoints

GET /api/v1/partners

List partner users with their profiles and commission structure

get
/partners
Required scopes
This endpoint requires the following scopes:
Authorizations
X-API-KeystringRequired

Scoped secret API key — send an sk_live_… value (keys issued before the typed format carry a bare pk_<hex> prefix and are also secret; they still work). A publishable pk_live_…/pk_test_… key is browser-safe, carries no scopes, and is refused by every endpoint in this spec with publishable_key_not_allowed. Coarse scopes: read, commerce, admin (admin covers everything below). Narrow per-resource scopes: journeys|pages :read|write|publish|delete, productsets :read|write|publish|delete, components|rules :read|write|delete, context :read (read-only context tier), catalog :read|write-native. publish is never implied by write.

Query parameters
limitinteger · min: 1 · max: 100Optional

Max items to return (1–100, default 20)

Default: 20
offsetintegerOptional

Number of items to skip (default 0)

Default: 0
Responses
200

Paginated list of partner users

application/json

A partner user enriched with their partner profile

idstring · uuidOptional
emailstring · emailOptional
isActivebooleanOptional
get/partners
GET /api/v1/partners HTTP/1.1
Host: api.peakcommerce.app
X-API-Key: YOUR_API_KEY
Accept: */*
200

Paginated list of partner users

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "email": "name@gmail.com",
  "isActive": true,
  "partnerProfile": {
    "companyName": "text",
    "contactName": "text",
    "contactEmail": "text",
    "tier": "text",
    "commissionStructureId": "text"
  }
}

Notes, examples, or caveats for GET /partners go here.

GET /api/v1/partners/{userId}

Get a partner user with their profile

get
/partners/{userId}
Required scopes
This endpoint requires the following scopes:
Authorizations
X-API-KeystringRequired

Scoped secret API key — send an sk_live_… value (keys issued before the typed format carry a bare pk_<hex> prefix and are also secret; they still work). A publishable pk_live_…/pk_test_… key is browser-safe, carries no scopes, and is refused by every endpoint in this spec with publishable_key_not_allowed. Coarse scopes: read, commerce, admin (admin covers everything below). Narrow per-resource scopes: journeys|pages :read|write|publish|delete, productsets :read|write|publish|delete, components|rules :read|write|delete, context :read (read-only context tier), catalog :read|write-native. publish is never implied by write.

Path parameters
userIdstringRequired
Responses
200

Partner details

application/json

A partner user enriched with their partner profile

idstring · uuidOptional
emailstring · emailOptional
isActivebooleanOptional
get/partners/{userId}
GET /api/v1/partners/{userId} HTTP/1.1
Host: api.peakcommerce.app
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "email": "name@gmail.com",
  "isActive": true,
  "partnerProfile": {
    "companyName": "text",
    "contactName": "text",
    "contactEmail": "text",
    "tier": "text",
    "commissionStructureId": "text"
  }
}

Notes, examples, or caveats for GET /partners/{userId} go here.

GET /api/v1/partners/{userId}/commissions

List commission records for a partner (performance read)

get
/partners/{userId}/commissions
Required scopes
This endpoint requires the following scopes:
Authorizations
X-API-KeystringRequired

Scoped secret API key — send an sk_live_… value (keys issued before the typed format carry a bare pk_<hex> prefix and are also secret; they still work). A publishable pk_live_…/pk_test_… key is browser-safe, carries no scopes, and is refused by every endpoint in this spec with publishable_key_not_allowed. Coarse scopes: read, commerce, admin (admin covers everything below). Narrow per-resource scopes: journeys|pages :read|write|publish|delete, productsets :read|write|publish|delete, components|rules :read|write|delete, context :read (read-only context tier), catalog :read|write-native. publish is never implied by write.

Path parameters
userIdstringRequired
Query parameters
limitinteger · min: 1 · max: 100Optional

Max items to return (1–100, default 20)

Default: 20
offsetintegerOptional

Number of items to skip (default 0)

Default: 0
Responses
200

Paginated list of commission records

No content
get/partners/{userId}/commissions
GET /api/v1/partners/{userId}/commissions HTTP/1.1
Host: api.peakcommerce.app
X-API-Key: YOUR_API_KEY
Accept: */*

No content

Notes, examples, or caveats for GET /partners/{userId}/commissions go here.

PUT /api/v1/partners/{userId}/profile

Create or update a partner's profile

put
/partners/{userId}/profile
Required scopes
This endpoint requires the following scopes:
Authorizations
X-API-KeystringRequired

Scoped secret API key — send an sk_live_… value (keys issued before the typed format carry a bare pk_<hex> prefix and are also secret; they still work). A publishable pk_live_…/pk_test_… key is browser-safe, carries no scopes, and is refused by every endpoint in this spec with publishable_key_not_allowed. Coarse scopes: read, commerce, admin (admin covers everything below). Narrow per-resource scopes: journeys|pages :read|write|publish|delete, productsets :read|write|publish|delete, components|rules :read|write|delete, context :read (read-only context tier), catalog :read|write-native. publish is never implied by write.

Path parameters
userIdstringRequired
Body
companyNamestringOptional
contactNamestringOptional
contactEmailstringOptional
tierstringOptional
commissionStructureIdstringOptional
Responses
200

Partner profile updated

No content
put/partners/{userId}/profile
PUT /api/v1/partners/{userId}/profile HTTP/1.1
Host: api.peakcommerce.app
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 110

{
  "companyName": "text",
  "contactName": "text",
  "contactEmail": "text",
  "tier": "text",
  "commissionStructureId": "text"
}
No content

Notes, examples, or caveats for PUT /partners/{userId}/profile go here.

GET /api/v1/partners/commission-structures

List all commission structures

get
/partners/commission-structures
Required scopes
This endpoint requires the following scopes:
Authorizations
X-API-KeystringRequired

Scoped secret API key — send an sk_live_… value (keys issued before the typed format carry a bare pk_<hex> prefix and are also secret; they still work). A publishable pk_live_…/pk_test_… key is browser-safe, carries no scopes, and is refused by every endpoint in this spec with publishable_key_not_allowed. Coarse scopes: read, commerce, admin (admin covers everything below). Narrow per-resource scopes: journeys|pages :read|write|publish|delete, productsets :read|write|publish|delete, components|rules :read|write|delete, context :read (read-only context tier), catalog :read|write-native. publish is never implied by write.

Query parameters
limitinteger · min: 1 · max: 100Optional

Max items to return (1–100, default 20)

Default: 20
offsetintegerOptional

Number of items to skip (default 0)

Default: 0
Responses
200

Paginated list of commission structures

application/json

A commission calculation structure for partner earnings

idstring · uuidOptional
namestringOptional
descriptionstring · nullableOptional
commissionTypestringOptional
ratenumber · nullableOptional
flatAmountnumber · nullableOptional
currencystring · nullableOptional
isActivebooleanOptional
createdAtstring · date-timeOptional
get/partners/commission-structures
GET /api/v1/partners/commission-structures HTTP/1.1
Host: api.peakcommerce.app
X-API-Key: YOUR_API_KEY
Accept: */*
200

Paginated list of commission structures

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "commissionType": "text",
  "rate": 1,
  "flatAmount": 1,
  "currency": "text",
  "isActive": true,
  "createdAt": "2026-01-01T00:00:00.000Z"
}

Notes, examples, or caveats for GET /partners/commission-structures go here.

POST /api/v1/partners/commission-structures

Create a commission structure

post
/partners/commission-structures
Required scopes
This endpoint requires the following scopes:
Authorizations
X-API-KeystringRequired

Scoped secret API key — send an sk_live_… value (keys issued before the typed format carry a bare pk_<hex> prefix and are also secret; they still work). A publishable pk_live_…/pk_test_… key is browser-safe, carries no scopes, and is refused by every endpoint in this spec with publishable_key_not_allowed. Coarse scopes: read, commerce, admin (admin covers everything below). Narrow per-resource scopes: journeys|pages :read|write|publish|delete, productsets :read|write|publish|delete, components|rules :read|write|delete, context :read (read-only context tier), catalog :read|write-native. publish is never implied by write.

Body
namestringRequired
commissionTypestringRequired
ratenumberOptional
flatAmountnumberOptional
currencystringOptional
Responses
201

Commission structure created

application/json

A commission calculation structure for partner earnings

idstring · uuidOptional
namestringOptional
descriptionstring · nullableOptional
commissionTypestringOptional
ratenumber · nullableOptional
flatAmountnumber · nullableOptional
currencystring · nullableOptional
isActivebooleanOptional
createdAtstring · date-timeOptional
post/partners/commission-structures
POST /api/v1/partners/commission-structures HTTP/1.1
Host: api.peakcommerce.app
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 81

{
  "name": "text",
  "commissionType": "text",
  "rate": 1,
  "flatAmount": 1,
  "currency": "text"
}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "commissionType": "text",
  "rate": 1,
  "flatAmount": 1,
  "currency": "text",
  "isActive": true,
  "createdAt": "2026-01-01T00:00:00.000Z"
}

Notes, examples, or caveats for POST /partners/commission-structures go here.

DELETE /api/v1/partners/commission-structures/{id}

Delete a commission structure

delete
/partners/commission-structures/{id}
Required scopes
This endpoint requires the following scopes:
Authorizations
X-API-KeystringRequired

Scoped secret API key — send an sk_live_… value (keys issued before the typed format carry a bare pk_<hex> prefix and are also secret; they still work). A publishable pk_live_…/pk_test_… key is browser-safe, carries no scopes, and is refused by every endpoint in this spec with publishable_key_not_allowed. Coarse scopes: read, commerce, admin (admin covers everything below). Narrow per-resource scopes: journeys|pages :read|write|publish|delete, productsets :read|write|publish|delete, components|rules :read|write|delete, context :read (read-only context tier), catalog :read|write-native. publish is never implied by write.

Path parameters
idstringRequired
Responses
204

Commission structure deleted

No content
delete/partners/commission-structures/{id}
DELETE /api/v1/partners/commission-structures/{id} HTTP/1.1
Host: api.peakcommerce.app
X-API-Key: YOUR_API_KEY
Accept: */*

No content

Notes, examples, or caveats for DELETE /partners/commission-structures/{id} go here.

GET /api/v1/partners/commission-structures/{id}

Get a commission structure

get
/partners/commission-structures/{id}
Required scopes
This endpoint requires the following scopes:
Authorizations
X-API-KeystringRequired

Scoped secret API key — send an sk_live_… value (keys issued before the typed format carry a bare pk_<hex> prefix and are also secret; they still work). A publishable pk_live_…/pk_test_… key is browser-safe, carries no scopes, and is refused by every endpoint in this spec with publishable_key_not_allowed. Coarse scopes: read, commerce, admin (admin covers everything below). Narrow per-resource scopes: journeys|pages :read|write|publish|delete, productsets :read|write|publish|delete, components|rules :read|write|delete, context :read (read-only context tier), catalog :read|write-native. publish is never implied by write.

Path parameters
idstringRequired
Responses
200

Commission structure details

application/json

A commission calculation structure for partner earnings

idstring · uuidOptional
namestringOptional
descriptionstring · nullableOptional
commissionTypestringOptional
ratenumber · nullableOptional
flatAmountnumber · nullableOptional
currencystring · nullableOptional
isActivebooleanOptional
createdAtstring · date-timeOptional
get/partners/commission-structures/{id}
GET /api/v1/partners/commission-structures/{id} HTTP/1.1
Host: api.peakcommerce.app
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "commissionType": "text",
  "rate": 1,
  "flatAmount": 1,
  "currency": "text",
  "isActive": true,
  "createdAt": "2026-01-01T00:00:00.000Z"
}

Notes, examples, or caveats for GET /partners/commission-structures/{id} go here.

PATCH /api/v1/partners/commission-structures/{id}

Update a commission structure

patch
/partners/commission-structures/{id}
Required scopes
This endpoint requires the following scopes:
Authorizations
X-API-KeystringRequired

Scoped secret API key — send an sk_live_… value (keys issued before the typed format carry a bare pk_<hex> prefix and are also secret; they still work). A publishable pk_live_…/pk_test_… key is browser-safe, carries no scopes, and is refused by every endpoint in this spec with publishable_key_not_allowed. Coarse scopes: read, commerce, admin (admin covers everything below). Narrow per-resource scopes: journeys|pages :read|write|publish|delete, productsets :read|write|publish|delete, components|rules :read|write|delete, context :read (read-only context tier), catalog :read|write-native. publish is never implied by write.

Path parameters
idstringRequired
Body
namestringOptional
commissionTypestringOptional
ratenumberOptional
isActivebooleanOptional
Responses
200

Commission structure updated

No content
patch/partners/commission-structures/{id}
PATCH /api/v1/partners/commission-structures/{id} HTTP/1.1
Host: api.peakcommerce.app
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 64

{
  "name": "text",
  "commissionType": "text",
  "rate": 1,
  "isActive": true
}
No content

Notes, examples, or caveats for PATCH /partners/commission-structures/{id} go here.

PreviousContent
NextRoles

Last updated

Was this helpful?