Skip to content

Aggregator API

Download OpenAPI description
aggregator.json
aggregator.yaml
Languages
Servers
Demo tenant

https://open-api-demo.open-api.perfectgym.com/

Mock server

https://redocly.sportalliance.com/_mock/apis/perfectgym/aggregator/aggregator/

Create aggregator member

Request

Required Scopes: AGGREGATOR_MEMBER_WRITE

Returns id of new aggregator member

Security
ApiKeyAuth
Bodyapplication/jsonrequired
aggregatorIdstringrequired

Customer aggregator id

Example: "fc336b0b-409c-4c66-a26d-ab25b87dcb8f"
firstNamestringrequired

First name of the customer

Example: "Edgar"
lastNamestringrequired

Last name of the customer

Example: "Bullock"
emailstring

Customer email

Example: "example@email.com"
dateOfBirthstring(date)

Birthday of the customer

Example: "1952-05-04"
genderstring

Gender of the customer

Enum ValueDescription
MALE

Male gender of the customer

FEMALE

Female gender of the customer

UNISEX

Unisex gender of the customer

Example: "MALE"
phonePrivatestring

Private phone number of the customer

Example: "+49 30901820"
phonePrivateMobilestring

Private mobile phone number of the customer

Example: "+49 15223433333"
phoneBusinessstring

Business phone number of the customer

Example: "+49 30901820"
phoneBusinessMobilestring

Business mobile phone number of the customer

Example: "+49 15223433333"
streetstring

Street of the customer

Example: "Am Bahnhof"
houseNumberstring

Number of the customer's house

Example: "89a"
zipCodestring

Zip code of the customer

Example: "12133"
citystring

City of the customer

Example: "Munich"
countrystring(ISO 3166-1)

Country code of the customer

Example: "DE"
curl -i -X POST \
  https://open-api-demo.open-api.perfectgym.com/v1/aggregators/member \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "aggregatorId": "fc336b0b-409c-4c66-a26d-ab25b87dcb8f",
    "firstName": "Edgar",
    "lastName": "Bullock",
    "email": "example@email.com",
    "dateOfBirth": "1952-05-04",
    "gender": "MALE",
    "phonePrivate": "+49 30901820",
    "phonePrivateMobile": "+49 15223433333",
    "phoneBusiness": "+49 30901820",
    "phoneBusinessMobile": "+49 15223433333",
    "street": "Am Bahnhof",
    "houseNumber": "89a",
    "zipCode": "12133",
    "city": "Munich",
    "country": "DE"
  }'

Responses

OK

Bodyapplication/json
customerIdinteger(int64)

Id of created customer

Example: 20322323
Response
application/json
{
  "customerId": 20322323
}