Get membership
curl --request GET \
--url https://api.gymdesk.com/memberships/{membershipId} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.gymdesk.com/memberships/{membershipId}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.gymdesk.com/memberships/{membershipId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.gymdesk.com/memberships/{membershipId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"data": {
"id": 1000,
"academyId": 123,
"name": "Monthly Unlimited Membership",
"active": true,
"familyMembership": false,
"pricing": {
"type": "recurring",
"price": {
"amount": 49.99,
"currency": "USD"
},
"signupFee": {
"amount": 149.99,
"currency": "USD"
},
"latePaymentFee": {
"amount": 10,
"currency": "USD"
},
"earlyCancellationFee": {
"amount": 0,
"currency": "USD"
},
"frequency": "P1M",
"maxNumberOfPayments": null,
"familyDiscounts": null,
"familyPricing": null
},
"duration": {
"type": "ongoing",
"timeLimitedOptions": null,
"enrollmentPeriodOptions": null
},
"access": {
"type": "unlimited",
"memberCapacity": null,
"limitOptions": null,
"allowedProgramIds": [
101,
102
]
}
},
"related": {
"programs": [
{
"id": 101,
"name": "Brazilian Jiu Jitsu"
},
{
"id": 102,
"name": "Muay Thai"
}
]
}
}Memberships
Get membership
Retrieve a membership definition by ID.
GET
/
memberships
/
{membershipId}
Get membership
curl --request GET \
--url https://api.gymdesk.com/memberships/{membershipId} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.gymdesk.com/memberships/{membershipId}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.gymdesk.com/memberships/{membershipId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.gymdesk.com/memberships/{membershipId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"data": {
"id": 1000,
"academyId": 123,
"name": "Monthly Unlimited Membership",
"active": true,
"familyMembership": false,
"pricing": {
"type": "recurring",
"price": {
"amount": 49.99,
"currency": "USD"
},
"signupFee": {
"amount": 149.99,
"currency": "USD"
},
"latePaymentFee": {
"amount": 10,
"currency": "USD"
},
"earlyCancellationFee": {
"amount": 0,
"currency": "USD"
},
"frequency": "P1M",
"maxNumberOfPayments": null,
"familyDiscounts": null,
"familyPricing": null
},
"duration": {
"type": "ongoing",
"timeLimitedOptions": null,
"enrollmentPeriodOptions": null
},
"access": {
"type": "unlimited",
"memberCapacity": null,
"limitOptions": null,
"allowedProgramIds": [
101,
102
]
}
},
"related": {
"programs": [
{
"id": 101,
"name": "Brazilian Jiu Jitsu"
},
{
"id": 102,
"name": "Muay Thai"
}
]
}
}Authorizations
Path Parameters
Query Parameters
Add related resources to the related property.
Available options:
program ⌘I