Appearance

Get distributors ​

GET
/v1/distributors

Gets a list of distributors

Authorizations​

api_key
Type
API Key (header: X-Api-Key)

Parameters​

Query Parameters

sorting
Type
string
Default
null
page_size

Number of items per page

Type
integer
Default
50
page

Current page

Type
integer
Default
1
distributor_id

distributor_id id to filter on

Type
string
query

Search by hashkey, name, or administrative email

Type
string
distributor_name

Filter by distributor name only

Type
string
distributor_status

Enum: disabled, grace_period, wait_activation, active, wait_approval

Type
string
business_segment

Enum: small, medium, large

Type
string
payment_segment

Enum: red, white, yellow, green, darkgreen

Type
string
iso_country

Country of distributor in iso format

Type
string
role

Filter distributors by role name (e.g., 'api', 'portal')

Type
string

Responses​

OK

application/json
JSON
{
  
"distributors": [
  
  
{
  
  
  
"customerservice": {
  
  
  
  
"email": null,
  
  
  
  
"url_website": null,
  
  
  
  
"phone_number": null,
  
  
  
  
"trade_name": null
  
  
  
},
  
  
  
"maincontact": {
  
  
  
  
"firstname": null,
  
  
  
  
"lastname": null,
  
  
  
  
"phonenumber": null,
  
  
  
  
"email": null
  
  
  
},
  
  
  
"financecontact": {
  
  
  
  
"firstname": null,
  
  
  
  
"lastname": null,
  
  
  
  
"phonenumber": null,
  
  
  
  
"email": null
  
  
  
},
  
  
  
"address": {
  
  
  
  
"country": null,
  
  
  
  
"city": null,
  
  
  
  
"province": null,
  
  
  
  
"number": null,
  
  
  
  
"postalcode": null,
  
  
  
  
"streetname": null,
  
  
  
  
"streetname2": null,
  
  
  
  
"latitude": null,
  
  
  
  
"longitude": null
  
  
  
},
  
  
  
"invoice_address": {
  
  
  
  
"country": null,
  
  
  
  
"city": null,
  
  
  
  
"province": null,
  
  
  
  
"number": null,
  
  
  
  
"postalcode": null,
  
  
  
  
"streetname": null,
  
  
  
  
"streetname2": null,
  
  
  
  
"latitude": null,
  
  
  
  
"longitude": null
  
  
  
},
  
  
  
"slug": null,
  
  
  
"iso_country": null,
  
  
  
"distributor_name": null,
  
  
  
"distributor_id": null,
  
  
  
"finance": {
  
  
  
  
"vat_number": null,
  
  
  
  
"member_state": null,
  
  
  
  
"contact_person": null,
  
  
  
  
"contact_person_firstname": null,
  
  
  
  
"contact_person_lastname": null,
  
  
  
  
"phone_number": null,
  
  
  
  
"administrative_email": null,
  
  
  
  
"payment_methods": [
  
  
  
  
  
"string"
  
  
  
  
],
  
  
  
  
"chamber_of_commerce": null,
  
  
  
  
"foreign_vat_numbers": {
  
  
  
  
  
"additionalProperties": "string"
  
  
  
  
},
  
  
  
  
"document_types_accessible": [
  
  
  
  
  
"string"
  
  
  
  
]
  
  
  
},
  
  
  
"distributor_status": null,
  
  
  
"distributor_supplier_status": null,
  
  
  
"see_own_supplier_tickets": null,
  
  
  
"roles": [
  
  
  
  
"string"
  
  
  
],
  
  
  
"administrative_email": null,
  
  
  
"sandbox_only": null,
  
  
  
"created": null,
  
  
  
"updated": null,
  
  
  
"created_by": null,
  
  
  
"updated_by": null,
  
  
  
"account_type": null,
  
  
  
"fixed_fee": null,
  
  
  
"payment_segment": null,
  
  
  
"business_segment": null,
  
  
  
"thirty_day_limit": null,
  
  
  
"sixty_day_limit": null,
  
  
  
"ninety_day_limit": null,
  
  
  
"total_deferred_limit": null,
  
  
  
"total_invoice_limit": null,
  
  
  
"supplier_id": null,
  
  
  
"sports_enabled": [
  
  
  
  
"string"
  
  
  
],
  
  
  
"sports_disabled": [
  
  
  
  
"string"
  
  
  
],
  
  
  
"grace_period_download_tickets": null,
  
  
  
"allowed_currencies": [
  
  
  
  
"string"
  
  
  
],
  
  
  
"preferred_currency": "EUR",
  
  
  
"sport_interests": [
  
  
  
  
"string"
  
  
  
],
  
  
  
"corporate_color": null,
  
  
  
"narrative_color": null,
  
  
  
"font_family": null,
  
  
  
"logo_url": null,
  
  
  
"payment_condition": null,
  
  
  
"ticket_sales_volume": null,
  
  
  
"distribution_channel_type": null,
  
  
  
"distributor_metadata": {
  
  
  
  
"additionalProperties": "string"
  
  
  
},
  
  
  
"signed_platform_agreement_date": null,
  
  
  
"signed_platform_agreement_version": null,
  
  
  
"logged_in_last_month": null,
  
  
  
"logged_in_last_3_months": null
  
  
}
  
],
  
"pagination": {
  
  
"total_size": 1,
  
  
"page_size": 50,
  
  
"page_number": 1,
  
  
"next_page": "string",
  
  
"previous_page": "string"
  
}
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​