Partner

Questi contenuti non sono ancora disponibili nella tua lingua.

Manage partners, which represent organizations or companies associated with your account.
You can create, update, delete, and search for partners with advanced filtering and pagination.

Version: 2.0.0
OpenAPI version: 3.0.0

Operations

index

POST

/v2/partner/index

Returns a paginated and filterable list of partners.
Use POST to allow complex filters via JSON payload.

Request Body

Parameters for searching partners

object

filter

object

partner_id

The unique identifier of the partner.

string

name

The name of the partner.

string

balance

The balance associated with the partner.

integer

status

The status of the partner (e.g., active, inactive).

integer

customer_id

The unique identifier of the customer associated with the partner.

string

subscription_id

The unique identifier of the subscription linked to the partner.

string

created_at

The timestamp when the partner was created.

integer

updated_at

The timestamp when the partner details were last updated.

integer

subscription_plan_id

The identifier of the subscription plan (varchar(50)).

string

<= 50 characters

subscription_npeople

The number of people included in the subscription (int(11)).

integer

subscription_nproject

The number of projects included in the subscription (int(11)).

integer

customer_email

The email address of the customer associated with the partner.

string

whitelabel

The type of white label (either ‘ADVANCED’, ‘SIMPLE’, or null).

string

nullable

Allowed values: ADVANCED SIMPLE

per-page

integer

default: 100 >= 1

page

integer

default: 1 >= 1

sort

The field of the model to sort the list for, use a minus to revert the sort. Es -name is to require the sort in reverse order

string

history

The field establishes whether to also include historized elements that are no longer active in the results. If you leave this parameter empty the response returns only actual entries.

boolean

Example

{
  "filter": {
    "name": "Partner 1",
    "status": 1
  },
  "per-page": 10,
  "page": 1,
  "sort": "name"
}

Responses

200

List of partners

Array<object>

object

partner_id

The unique identifier of the partner.

string

name

The name of the partner.

string

balance

The balance associated with the partner.

integer

status

The status of the partner (e.g., active, inactive).

integer

customer_id

The unique identifier of the customer associated with the partner.

string

subscription_id

The unique identifier of the subscription linked to the partner.

string

created_at

The timestamp when the partner was created.

integer

updated_at

The timestamp when the partner details were last updated.

integer

subscription_plan_id

The identifier of the subscription plan (varchar(50)).

string

<= 50 characters

subscription_npeople

The number of people included in the subscription (int(11)).

integer

subscription_nproject

The number of projects included in the subscription (int(11)).

integer

customer_email

The email address of the customer associated with the partner.

string

whitelabel

The type of white label (either ‘ADVANCED’, ‘SIMPLE’, or null).

string

nullable

Allowed values: ADVANCED SIMPLE

Example

{
  "partner_id": "par-1",
  "name": "Partner 1",
  "balance": 1000,
  "status": 1,
  "customer_id": "cus-1",
  "subscription_id": "sub-1",
  "created_at": 1700000000,
  "updated_at": 1700000001,
  "whitelabel": "ADVANCED"
}

Headers

X-Pagination-Current-Page

integer

Current page

X-Pagination-Page-Count

integer

Total number of pages

X-Pagination-Per-Page

integer

Number of items per page

X-Pagination-Total-Count

integer

Total number of items

view

GET

/v2/partner/view/{id}

Retrieve a partner by its unique ID.

Path Parameters

required

string format: uuid

ID of the partner to retrieve

Responses

200

Partner found

object

partner_id

The unique identifier of the partner.

string

name

The name of the partner.

string

balance

The balance associated with the partner.

integer

status

The status of the partner (e.g., active, inactive).

integer

customer_id

The unique identifier of the customer associated with the partner.

string

subscription_id

The unique identifier of the subscription linked to the partner.

string

created_at

The timestamp when the partner was created.

integer

updated_at

The timestamp when the partner details were last updated.

integer

subscription_plan_id

The identifier of the subscription plan (varchar(50)).

string

<= 50 characters

subscription_npeople

The number of people included in the subscription (int(11)).

integer

subscription_nproject

The number of projects included in the subscription (int(11)).

integer

customer_email

The email address of the customer associated with the partner.

string

whitelabel

The type of white label (either ‘ADVANCED’, ‘SIMPLE’, or null).

string

nullable

Allowed values: ADVANCED SIMPLE

Example

{
  "partner_id": "par-1",
  "name": "Partner 1",
  "balance": 1000,
  "status": 1,
  "customer_id": "cus-1",
  "subscription_id": "sub-1",
  "created_at": 1700000000,
  "updated_at": 1700000001,
  "whitelabel": "ADVANCED"
}

404

Partner not found