Company

Last updated 5 months ago

This endpoint is not yet operational and is thus subject to change.

get
Show Company

https://api.clubcollect.com/api
/v2/companies/:id
Fetch a Company’s details.
Request
Response
Path Parameters
id
required
string
Company ID, supplied by ClubCollect.
Query Parameters
api_key
required
string
Partner API Key.
200: OK
Company successfully retrieved.
{
"company_id": "a1f3216863ba5d5424dcbace46ab37be98d70c92",
"name": "Amsterdam Collectors FC",
"brand": "clubcollect",
"email": "admin@amscollectors.nl",
"locale": "nl",
"address1": "Sint Pieterspoortsteeg",
"address2": "2nd floor",
"house_number": "2",
"zipcode": "1012 HM",
"city": "Amsterdam",
"country_code": "NL",
"currency": "EUR"
}
404: Not Found
Could not find a Company with this ID.
{
"errors": "not_found"
}

post
Create Company

https://api.clubcollect.com/api
/v2/companies
Create a new Company.
Request
Response
Query Parameters
api_key
required
string
Partner API Key.
Body Parameters
name
required
string
Name of Company.
cbio_trial
required
boolean
When true, some mandatory parameters become optional.
brand
required
string
Brand code. From { clubbaseio knltb dtb clubcollect clubcollectde }.
email
required
string
Email address of Company contact.
locale
required
string
Default locale for Company members. From { de en fr it nl }.
country_code
required
string
Country of official Company registration. From { AT BE CH DE GB IE NL }.
address1
optional
string
address2
optional
string
house_number
optional
string
zipcode
optional
string
city
optional
string
vat_percentage
optional
number
partnership_page_url
optional
string
currency
required
string
Currency. From { EUR GBP CHF }.
200: OK
Company successfully created.
{
"company_id": "a1f3216863ba5d5424dcbace46ab37be98d70c92",
"name": "Amsterdam Collectors FC",
"brand": "clubcollect",
"email": "admin@amscollectors.nl",
"locale": "nl",
"address1": "Sint Pieterspoortsteeg",
"address2": "2nd floor",
"house_number": "2",
"zipcode": "1012 HM",
"city": "Amsterdam",
"country_code": "NL",
"currency": "EUR"
}

put
Update Company

https://api.clubcollect.com/api
/v2/companies/:id
Update Company details.
Request
Response
Path Parameters
id
required
string
Company ID, supplied by ClubCollect.
Query Parameters
api_key
required
string
Partner API Key.
200: OK
{
"company_id": "a1f3216863ba5d5424dcbace46ab37be98d70c92",
"name": "Amsterdam Collectors FC",
"brand": "clubcollect",
"email": "admin@amscollectors.nl",
"locale": "nl",
"address1": "Sint Pieterspoortsteeg",
"address2": "2nd floor",
"house_number": "2",
"zipcode": "1012 HM",
"city": "Amsterdam",
"country_code": "NL",
"currency": "EUR"
}

Parameters for PUT are the same as POST.