List partners

GET

/api/v1/partners

const url = 'https://example.com/api/v1/partners?page=1&per_page=10';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://example.com/api/v1/partners?page=1&per_page=10' \
  --header 'Authorization: Bearer <token>'

Authorizations

bearerAuth

Parameters

Query Parameters

ids

Array<string>

Filter by partner IDs

customer_ids

Array<string>

Filter by customer IDs

workspace_ids

Array<string>

Filter by workspace IDs

name

string

Filter by partner name (case-insensitive substring match)

page

integer

default: 1 >= 1

Page number for pagination (default: 1)

per_page

integer

default: 10 >= 1 <= 100

Number of items per page for pagination (default: 10)

Responses

200

application/json

object

partners

required

Array<object>

object

required

Unique identifier of the partner

string format: uuid

name

required

Name of the partner

string

customer_id

required

ID of the customer this partner belongs to

string format: uuid

workspace_id

required

ID of the workspace this partner belongs to

string format: uuid

billing_mode

Billing mode for this partner (null if not configured)

string

nullable

Allowed values: self_billing partner_billing

self_billing_data

Present when billing_mode is self_billing. Contains all invoice generation data.

object

legal_name

required

Legal entity name of the partner (used on invoices)

string

address

required

Registered business address shown on invoices

object

street

required

Street address including house number

string

city

required

City

string

region

required

State, province, or region

string

postal_code

required

Postal or ZIP code

string

country

required

ISO 3166-1 alpha-2 country code

string

vat_number

required

VAT or tax registration number (e.g. “FR12345678901”)

string

payment_terms_days

required

Number of days after invoice issuance until payment is due

integer

bank_account

required

Bank account to which the settlement amount should be transferred

object

beneficiary_name

required

Name of the bank account beneficiary

string

iban

required

International Bank Account Number

string

bic

required

Bank Identifier Code (SWIFT/BIC)

string

tax_config

required

Tax treatment applied to this partner’s invoices

object

treatment

required

Tax treatment applied to commissions paid to this partner

string

Allowed values: standard reverse_charge exempt

label

required

Tax label printed on invoices (e.g. “VAT”, “TVA”, “MwSt”)

string

rate_bps

Tax rate in basis points (e.g. 2000 = 20%). Required when treatment is standard.

integer

nullable

total

required

Total number of partners matching the query

integer

page

required

Current page number

integer

per_page

required

Number of partners returned per page

integer

Example

{
  "partners": [
    {
      "billing_mode": "self_billing",
      "self_billing_data": {
        "tax_config": {
          "treatment": "standard"
        }
      }
    }
  ]
}

401

Unauthorized

application/json

object

error_code

required

string

Allowed values: UNAUTHORIZED NOT_FOUND INTERNAL_ERROR BAD_REQUEST FORBIDDEN CONFLICT

message

required

string

Example

{
  "error_code": "UNAUTHORIZED",
  "message": "Authentication credentials were not provided or are invalid."
}

500

Internal server error

application/json

object

error_code

required

string

Allowed values: UNAUTHORIZED NOT_FOUND INTERNAL_ERROR BAD_REQUEST FORBIDDEN CONFLICT

message

required

string

Example

{
  "error_code": "UNAUTHORIZED",
  "message": "Authentication credentials were not provided or are invalid."
}