Company

Manage Companies, the entity representing an individual organisation.

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

Show Company

GET https://app.clubcollect.com/api/v2/companies/:id

Fetch a Company’s details.

Path Parameters

Name	Type	Description
id*	string	Company ID, supplied by ClubCollect.

Query Parameters

Name	Type	Description
api:key	string	Partner API Key (Deprecated)

Headers

Name	Type	Description
Authorization*	string	ApiKey <api_key>

200

{
  "company_id": "a1f3216863ba5d5424dcbace46ab37be98d70c92", 
  "name": "Amsterdam Collectors FC",
  "brand": "clubcollect",
  "email": "[e-mail]",
  "locale": "nl",
  "address1": "Sint Pieterspoortsteeg",
  "address2": "2nd floor",
  "house_number": "2",
  "zipcode": "1012 HM",
  "city": "Amsterdam",
  "country_code": "NL",
  "currency": "EUR"
}

404

{
    "errors": "not_found"
}

Create Company

POST https://app.clubcollect.com/api/v2/companies

Create a new Company.

Query Parameters

Name	Type	Description
api:key	string	Partner API Key (Deprecated)

Headers

Name	Type	Description
Authorization*	string	ApiKey <api_key>

Request Body

Name	Type	Description
name*	string	Name of Company.
brand*	string	Brand code. From { clubbaseio knltb dtb clubcollect clubcollectde }.
email*	string	Email address of Company contact.
locale*	string	Default locale for Company members. From { de en fr it nl }.
country:code*	string	Country of official Company registration. From { AT BE CH DE GB IE NL }.
address1	string
address2	string
house:number	string
zipcode	string
city	string
vat:percentage	number
partnership:page:url	string
currency*	string	Currency. From { EUR GBP CHF }.

200

{
  "company_id": "a1f3216863ba5d5424dcbace46ab37be98d70c92",
  "name": "Amsterdam Collectors FC",
  "brand": "clubcollect",
  "email": "[e-mail]",
  "locale": "nl",
  "address1": "Sint Pieterspoortsteeg",
  "address2": "2nd floor",
  "house_number": "2",
  "zipcode": "1012 HM",
  "city": "Amsterdam",
  "country_code": "NL",
  "currency": "EUR"
}

Update Company

PUT https://app.clubcollect.com/api/v2/companies/:id

Update Company details.

Path Parameters

Name	Type	Description
id*	string	Company ID, supplied by ClubCollect.

Query Parameters

Name	Type	Description
api:key	string	Partner API Key (Deprecated)

Headers

Name	Type	Description
Authorization*	string	ApiKey <api_key>

200

{
  "company_id": "a1f3216863ba5d5424dcbace46ab37be98d70c92",
  "name": "Amsterdam Collectors FC",
  "brand": "clubcollect",
  "email": "[e-mail]",
  "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.