Clubway public API (2.5)

Download OpenAPI specification:Download

This document describes the API that clubs can use to communicate with Clubway. Usage of API must be enabled by the Clubway support team.

Privacy

When using personal information of members obtained through API, the API user must adhere to the privacy settings defined by the member. Member can specify that any of his/her personal information can or cannot be displayed publicly. If the accessibility is public, that information can be displayed publicly for example on the club's website. If the accessibility is none, the information must not be displayed to unlimited audience, for example openly on the public internet.

Details on how the accessibility is presented are listed on corresponding endpoint descriptions.

Accessing API

API access is bound to a specific user in the club. All actions performed via API are associated with that user, i.e. API user can perform all actions and has same visibility than the user via Web-interface. Updating and deleting events is only possible for events created by the same API user.

The API key must be sent as HTTP header with all requests


X-myClub-token: ec608ee3a007433afb274de88cb31bd5

Rate limits

There is a rate limit of 300 requests / hour for each API key with a burst of 500 requests (i.e. you can make 500 requests at a time, but then you will have to wait for 100 minutes before you can make your next request). If you make a request that exceeds the rate limit you will receive HTTP response 503 Service Unavailable

Changelog

Version 2.5 (June 2, 2025)

List members endpoint and updates to events & courses list

Members List members available
Pagination to events & courses list (300 limit by default)

Version 2.4 (March 17, 2025)

Changes to Contracts

Contract creating supports now unit_price. This is the price for the contract and it defaults to 0. unit_price is also now returned in the contract list.

Version 2.3 (November 12, 2024)

New endpoint Kinds

Kinds List sports available

Updates to old endpoints

Groups

New attribute kind_ids
Courses

New attributes venue_ids and space_left

Version 2.2 (October 21, 2024)

Event embed endpoint changes and deprecations

Visibilities of the events can be now explicitly set with a collection of none, group, club, public and course.

all-value is deprecated and will be removed in the future. all is equivalent to group, club and public.

Response of the event embed still contains the visibility field, but it is deprecated and will be removed in the future. Instead, the visibilities field should be used.

When creating an event, the visibility field is still used. It still accepts the old values (string), but the new values (array of strings) are recommended.

Event embeds

Version 2.1 (July 11, 2023)

New endpoint Contracts

Contracts
Create contract
Contract services

Version 2.0 (June 20, 2022)

Notifications

Now accepts and returns details_html instead of details. The details paramter can still be used, but markdown will no longer be processed.
Events

Now accepts and returns description_html instead of description. The description paramter can still be used, but markdown will no longer be processed.

Version 1.21 (January 31, 2022)

Member.male is replaced with member.gender

All endpoints that used to return member.male (boolean) now instead return member.gender (string).
Possible values for gender are 'male', 'female', 'other', 'undefined' (default)
When creating a member, the old male attribute is still accepted, but it is converted to gender.

Updates to old endpoints

Shop orders

Removed line.variant-attribute from response.
Returned collection is limited
since-params supports time

Version 1.20 (December 23, 2021)

New endpoints

Courses
Course embeds

Version 1.19 (December 8, 2021)

Participations can be unconfirmed.

Version 1.18 (October 11, 2021)

Events list can be filtered with only events that have updated or its participations have updated after a selected time. Also events event_recurrency_id is returned.

Version 1.17 (April 30, 2021)

Shop orders example JSON product name changed to visible_name.

Version 1.16 (April 19, 2021)

New endpoint

Shop orders list club web shop orders.

Version 1.15 (October 6, 2020)

New endpoint

Group levels display detailed information about group levels.
Custom fields list club custom fields.

Version 1.14 (September 9, 2020)

Updates to old endpoints

Member Embeds supports new types and allows setting visible fields for them. Requires Home Page add-on to be active.

Version 1.13 (September 18, 2019)

New endpoint

Shop Product Embeds

Version 1.12 (February 26, 2019)

Updates to old endpoints

Groups has new fields: description, description_html.

Version 1.11 (February 5, 2019)

Updates to old endpoints

Events has new fields: accepted_card_product_ids.

New endpoint

Card products

Version 1.10 (December 20, 2018)

Updates to old endpoints

Notifications has new fields: photo.
Groups has new fields: photo.

Version 1.9 (December 11, 2018)

Updates to old endpoints

Notifications has new fields: published_at and updated_at.

Version 1.8 (December 10, 2018)

New endpoint

Club

Version 1.7 (November 22, 2018)

New endpoints

Member Embeds
Notification Embeds

Updates to old endpoints

Notifications now also includes attachments.

Version 1.6 (November 8, 2018)

New endpoints

Embed Styles
Event Embeds
Notifications

Updates to old endpoints

Events list has new parameters to use in querying and max limit of 300 events returned. Participant info can also be included in result.

Version 1.5 (April 9, 2018)

Removed login from Member Create. For backwards compatibility a value for login can still be provied, but will be ignored.
Removed login, login_count, last_login_at, failed_login_count from Member Show and Member Search

Version 1.4 (January 31, 2018)

Privacy instructions added
Member Show now includes information on which fields the member has allowed to be publicly shown

Version 1.3 (May 30, 2016)

Event Get now includes invoices
Member Show now includes invoices

Version 1.2 (May 19, 2016)

Events now include event categories
New endpoint to get Event Categories

Version 1.1 (October 22, 2015 )

Action | Change

-------|------------

Event Get|Result now includes participants

Event List|List events in a group

Member Show|Link to member avatar is now included in result set

Group Memberships|New endpoint to return list of group membership

Events

List events

Lists events in given group. Events in subgroups are not included in the result. Results can be further filtered by given parameters. Events to which user has no access will be excluded from the result.

Authorizations:

ApiToken

query Parameters

course_ids	Array of numbers ids of the courses to list events for.
end_date	string <date> Events that start or end on or before that date will be returned.
group_id	number id of the group to list events for.
group_ids	Array of numbers ids of the groups to list events for.
ids	Array of numbers ids of the events to list.
include_participants	boolean Default: false Include particpants for each event
limit	number Limit the number of events returned. Default is 300.
page	number The page of the result set. Default is 1.
start_date	string <date> Default: "yesterday's date" Events that start or end on or after that date will be returned.
updated_after	string <date-time> Events basic information or its participations have changed after timestamp
venue_id	number

Responses

Response samples

200

Content type

application/json

[{"event": {"allow_comments": true,
"course_id": null,
"description": null,
"description_html": null,
"ends_at": "2014-10-30T06:00:00+02:00",
"event_category_id": 91,
"group_id": 34,
"id": 651,
"instructor_ids": [1,
24
],
"max_participations": null,
"name": "Morning Ice",
"participants_public": true,
"powerup_image_url": "https://someurl.com",
"queue_enabled": false,
"registration": "group",
"registration_closes_at": null,
"registration_opens_at": null,
"send_confirmation": false,
"starts_at": "2014-10-30T06:00:00+02:00",
"venue_id": 83,
"visibility": "group",
"accepted_card_product_ids": [10,
11
]
}
}
]

Create event

Authorizations:

ApiToken

Request Body schema: application/json

object

Event

Responses

Request samples

Payload

Content type

application/json

{"event": {"name": "Morning Ice",
"starts_at": "2014-10-30 06:00:00",
"ends_at": "2014-10-30 06:00:00",
"group_id": 34,
"venue_id": 83
}
}

Response samples

200

Content type

application/json

{"event": {"allow_comments": true,
"course_id": null,
"description": null,
"description_html": null,
"ends_at": "2014-10-30T06:00:00+02:00",
"event_category_id": null,
"group_id": 34,
"id": 651,
"instructor_ids": [1,
24
],
"max_participations": null,
"name": "Morning Ice",
"participants_public": true,
"powerup_image_url": "https://someurl.com",
"queue_enabled": false,
"registration_closes_at": null,
"registration_opens_at": null,
"registration": "group",
"send_confirmation": false,
"starts_at": "2014-10-30T06:00:00+02:00",
"venue_id": 83,
"visibility": "group"
}
}

Show event

Authorizations:

ApiToken

path Parameters

id

required

number

ID of the event

Responses

Response samples

200

Content type

application/json

{"event": {"allow_comments": true,
"course_id": null,
"description": null,
"description_html": null,
"ends_at": "2014-10-30T06:00:00+02:00",
"event_category": {"color": "#00ffff",
"name": "Training"
},
"group_id": 34,
"id": 651,
"instructor_ids": [1,
24
],
"invoices": [{"due_amount": "25.0",
"due_date": "2015-10-23",
"id": 101,
"member_id": 105,
"status": "open"
},
{"due_amount": "12.0",
"due_date": "2015-10-25",
"id": 102,
"member_id": 106,
"status": "paid"
}
],
"max_participations": null,
"name": "Morning Ice",
"participants_public": true,
"powerup_image_url": "https://someurl.com",
"queue_enabled": false,
"registration": "group",
"registration_closes_at": null,
"registration_opens_at": null,
"send_confirmation": false,
"starts_at": "2014-10-30T06:00:00+02:00",
"venue_id": 83,
"visibility": "group",
"participations": [{"comment": null,
"confirmed_at": "2015-10-22T10:30:50+03:00",
"created_at": "2015-10-16T13:11:13+03:00",
"price": null,
"queue_order": 0,
"registered_order": 1,
"self_registration": false,
"updated_at": "2015-10-22T10:30:50+03:00",
"member_id": 87338,
"indication": "no_response"
},
{"comment": null,
"confirmed_at": null,
"created_at": "2015-10-16T13:11:13+03:00",
"price": null,
"queue_order": 0,
"registered_order": 2,
"self_registration": false,
"updated_at": "2015-10-16T13:11:13+03:00",
"member_id": 87346,
"indication": "yes"
}
],
"accepted_card_product_ids": [10,
11
]
}
}

Update event

Authorizations:

ApiToken

path Parameters

id

required

number

ID of the event

Request Body schema: application/json

object (event-core)

Responses

Request samples

Payload

Content type

application/json

{"event": {"name": "Morning Ice",
"starts_at": "2014-10-30 06:00:00",
"ends_at": "2014-10-30 06:00:00",
"group_id": 34,
"venue_id": 83
}
}

Response samples

200

Content type

application/json

{"event": {"allow_comments": true,
"course_id": null,
"description": null,
"description_html": null,
"ends_at": "2014-10-30T06:00:00+02:00",
"event_category_id": null,
"group_id": 34,
"id": 651,
"instructor_ids": [1,
24
],
"max_participations": null,
"name": "Morning Ice",
"participants_public": true,
"powerup_image_url": "https://someurl.com",
"queue_enabled": false,
"registration": "group",
"registration_closes_at": null,
"registration_opens_at": null,
"send_confirmation": false,
"starts_at": "2014-10-30T06:00:00+02:00",
"venue_id": 83,
"visibility": "group"
}
}

Delete event

Authorizations:

ApiToken

path Parameters

id

required

number

ID of the event

Responses

Response samples

200

Content type

application/json

{"message": "ok"
}

Courses

List courses

Lists courses in given group. Courses in subgroups are not included in the result. Results can be further filtered by given parameters. Courses to which user has no access will be excluded from the result. Maximum of 300 courses are returned.

Authorizations:

ApiToken

query Parameters

end_date	string <date> Courses that start or end on or before that date will be returned.
group_id	number id of the group to list courses for.
group_ids	Array of numbers ids of the groups to list courses for.
ids	Array of numbers ids of the courses to list.
include_participants	boolean Default: false Include participants for each course
start_date	string <date> Default: "yesterday's date" Courses that start or end on or after that date will be returned.
updated_after	string <date-time> Courses basic information or its participations have changed after timestamp.
visibility	Array of any Items Enum: "none" "group" "club" "public" Courses with given visibilities are return.

Responses

Response samples

200

Content type

application/json

[{"course": {"id": 0,
"allow_comments": true,
"course_duration_type": "events",
"description_html": "string",
"event_category_id": 0,
"group_id": 0,
"max_participations": 0,
"name": "string",
"queue_enabled": true,
"registration": "none",
"registration_closes_at": "string",
"registration_opens_at": "string",
"send_confirmation": true,
"visibility": "none",
"powerup_image_url": "string",
"space_left": 0,
"venue_ids": [0
],
"description": "string"
}
}
]

Create course

Authorizations:

ApiToken

Request Body schema: application/json

object

Course

Responses

Request samples

Payload

Content type

application/json

{"course": {"name": "Morning Ice",
"registration_opens_at": "2022-10-30 06:00:00",
"group_id": 34
}
}

Response samples

200

Content type

application/json

{"course": {"allow_comments": true,
"description": null,
"description_html": null,
"ends_at": "2022-10-30T06:00:00+02:00",
"event_category_id": null,
"group_id": 34,
"id": 651,
"instructor_ids": [1,
24
],
"max_participations": null,
"name": "Morning Ice",
"powerup_image_url": "https://someurl.com",
"queue_enabled": false,
"registration_closes_at": null,
"registration_opens_at": null,
"registration": "group",
"send_confirmation": false,
"starts_at": "2022-10-30T06:00:00+02:00",
"visibility": "group"
}
}

Show course

Authorizations:

ApiToken

path Parameters

id

required

number

ID of the course

Responses

Response samples

200

Content type

application/json

{"course": {"allow_comments": true,
"description": null,
"description_html": null,
"ends_at": "2022-10-30T06:00:00+02:00",
"event_category": {"color": "#00ffff",
"name": "Training"
},
"group_id": 34,
"id": 651,
"instructor_ids": [1,
24
],
"invoices": [{"due_amount": "25.0",
"due_date": "2015-10-23",
"id": 101,
"member_id": 105,
"status": "open"
},
{"due_amount": "12.0",
"due_date": "2015-10-25",
"id": 102,
"member_id": 106,
"status": "paid"
}
],
"max_participations": null,
"name": "Morning Ice",
"powerup_image_url": "https://someurl.com",
"queue_enabled": false,
"registration": "group",
"registration_closes_at": null,
"registration_opens_at": null,
"send_confirmation": false,
"starts_at": "2022-10-30T06:00:00+02:00",
"visibility": "group",
"participations": [{"comment": null,
"confirmed_at": "2015-10-22T10:30:50+03:00",
"created_at": "2015-10-16T13:11:13+03:00",
"price": null,
"queue_order": 0,
"registered_order": 1,
"self_registration": false,
"updated_at": "2015-10-22T10:30:50+03:00",
"member_id": 87338,
"indication": "no_response"
},
{"comment": null,
"confirmed_at": null,
"created_at": "2015-10-16T13:11:13+03:00",
"price": null,
"queue_order": 0,
"registered_order": 2,
"self_registration": false,
"updated_at": "2015-10-16T13:11:13+03:00",
"member_id": 87346,
"indication": "yes"
}
],
"accepted_card_product_ids": [10,
11
]
}
}

Update course

Authorizations:

ApiToken

path Parameters

id

required

number

ID of the course

Request Body schema: application/json

object

Course

Responses

Request samples

Payload

Content type

application/json

{"course": {"name": "Morning Ice",
"registration_opens_at": "2022-10-30 06:00:00",
"group_id": 34
}
}

Response samples

200

Content type

application/json

{"course": {"allow_comments": true,
"description": null,
"description_html": null,
"ends_at": "2022-10-30T06:00:00+02:00",
"event_category_id": null,
"group_id": 34,
"id": 651,
"instructor_ids": [1,
24
],
"max_participations": null,
"name": "Morning Ice",
"powerup_image_url": "https://someurl.com",
"queue_enabled": false,
"registration": "group",
"registration_closes_at": null,
"registration_opens_at": null,
"send_confirmation": false,
"starts_at": "2022-10-30T06:00:00+02:00",
"visibility": "group"
}
}

Delete course

Authorizations:

ApiToken

path Parameters

id

required

number

ID of the course

Responses

Response samples

200

Content type

application/json

{"message": "ok"
}

Members

Create member

Only API users which is club owner can create new members.

Authorizations:

ApiToken

Request Body schema: application/json

object

Member

Responses

Request samples

Payload

Content type

application/json

{"member": {"birthday": "1990-01-01",
"city": "Espoo",
"clothing_size": "M",
"email": "john.doe@spam.com",
"gender": "male",
"street": "Albergan puistotie",
"zip": "02600",
"first_name": "John",
"last_name": "Doe",
"custom_values": {"Integer Custom Field": 1,
"Boolean Custom Field": true,
"Date Custom Field": "2014-01-01",
"Multiselect Custom Field": ["Multiselect Item 1",
"Multiselect Item 2"
]
}
}
}

Response samples

200

Content type

application/json

{"member_id": 10001
}

List members

IMPORTANT PRIVACY NOTICE

public_fields and public_custom_fields elements describe which information the member has decided to make publicly available. If a field is not listed in these elements IT'S VALUE MUST NOT BE DISPLAYED PUBLICLY.

Authorizations:

ApiToken

query Parameters

group_ids	Array of integers Array of group ids to show only members that have membership in these groups
ids	Array of integers Array of member ids to show
limit	number Limit the number of members returned. Default is 300.
page	number The page of the result set. Default is 1.
roster_ids	Array of integers Array of roster ids to show only members belonging to these rosters

Responses

Response samples

200

Content type

application/json

[{"member": {"active": true,
"birthday": "1990-01-01",
"city": "Espoo",
"clothing_size": "M",
"club_id": 9,
"competition_number": "42",
"country": "Suomi",
"created_at": "2014-11-12T11:02:26+02:00",
"email": "john.doe@spam.com",
"email_2": "jack.doe@spam.com",
"email_3": "jane.doe@spam.com",
"external_license_id": "007",
"first_name": "John",
"gender": "male",
"guardian_1_name": "Jack Doe",
"guardian_1_phone": "+35891234",
"guardian_2_name": "Jane Doe",
"guardian_2_phone": "+35891234",
"hcp": "13.0",
"height": 178,
"id": 1234,
"invoicing_info": null,
"joined_at": "2014-01-01",
"last_name": "Doe",
"last_request_at": null,
"left_at": null,
"locale": "fi",
"member_invoicing_address": null,
"notes": null,
"organisation": null,
"own_notes": null,
"phone": "+24591234",
"photography_permission": true,
"street": "Albergan puistotie",
"terms_accepted": false,
"updated_at": "2014-11-12T11:20:55+02:00",
"week_mail": true,
"weight": "76.0",
"zip": "02600",
"memberships": [ ],
"custom_values": [{"title": "Pelipaikka",
"data_type": "multilist",
"value": ["Maalivahti"
]
},
{"title": "Boolean",
"data_type": "boolean",
"value": false
}
],
"avatars": {"mini": "https://..../8989-32fe945fc0d6ed5efa499f08b35e67914f16bd81-mini.jpg",
"small": "https://..../8989-32fe945fc0d6ed5efa499f08b35e67914f16bd81-small.jpg",
"medium": "https://..../8989-32fe945fc0d6ed5efa499f08b35e67914f16bd81-medium.jpg",
"original": "https://..../8989-32fe945fc0d6ed5efa499f08b35e67914f16bd81-original.jpg"
},
"public_fields": ["first_name",
"last_name",
"phone"
],
"public_custom_fields": ["Pelipaikka"
]
}
},
{"member": {"active": true,
"birthday": "2002-10-01",
"city": "Espoo",
"clothing_size": "M",
"club_id": 9,
"competition_number": "12",
"country": "Suomi",
"created_at": "2014-11-12T11:02:26+02:00",
"email": "jane.doe@spam.com",
"email_2": "jack.doe@spam.com",
"email_3": "john.doe@spam.com",
"external_license_id": null,
"first_name": "Jane",
"gender": "female",
"guardian_1_name": "Jack Doe",
"guardian_1_phone": "+35891234",
"guardian_2_name": "John Doe",
"guardian_2_phone": "+35891234",
"hcp": null,
"height": 163,
"id": 1235,
"invoicing_info": null,
"joined_at": "2014-01-01",
"last_name": "Doe",
"last_request_at": null,
"left_at": null,
"locale": "fi",
"member_invoicing_address": {"city": "Espoo",
"country": "Suomi",
"enabled": true,
"first_name": "Jane",
"last_name": "Doe",
"street": "Albergan puistotie",
"zip": "02600"
},
"notes": null,
"organisation": null,
"own_notes": null,
"phone": "+24591234",
"photography_permission": true,
"street": "Albergan puistotie",
"terms_accepted": false,
"updated_at": "2014-11-12T11:20:55+02:00",
"week_mail": true,
"weight": "76.0",
"zip": "02600",
"memberships": [ ],
"custom_values": [{"title": "Pelipaikka",
"data_type": "multilist",
"value": ["Hyökkääjä"
]
},
{"title": "Boolean",
"data_type": "boolean",
"value": false
}
],
"avatars": {"mini": "https://..../8989-32fe945fc0d6ed5efa499f08b35e67914f16bd81-mini.jpg",
"small": "https://..../8989-32fe945fc0d6ed5efa499f08b35e67914f16bd81-small.jpg",
"medium": "https://..../8989-32fe945fc0d6ed5efa499f08b35e67914f16bd81-medium.jpg",
"original": "https://..../8989-32fe945fc0d6ed5efa499f08b35e67914f16bd81-original.jpg"
},
"public_fields": ["first_name",
"last_name",
"phone"
],
"public_custom_fields": ["Pelipaikka"
]
}
}
]

Show member

IMPORTANT PRIVACY NOTICE

public_fields and public_custom_fields elements describe which information the member has decided to make publicly available. If a field is not listed in these elements IT'S VALUE MUST NOT BE DISPLAYED PUBLICLY.

Authorizations:

ApiToken

path Parameters

id

required

number

Responses

Response samples

200

Content type

application/json

{"member": {"active": true,
"birthday": "1990-01-01",
"city": "Espoo",
"clothing_size": "M",
"club_id": 9,
"competition_number": "42",
"country": "Suomi",
"created_at": "2014-11-12T11:02:26+02:00",
"email": "john.doe@spam.com",
"email_2": "jack.doe@spam.com",
"email_3": "jane.doe@spam.com",
"external_license_id": "007",
"first_name": "John",
"gender": "male",
"guardian_1_name": "Jack Doe",
"guardian_1_phone": "+35891234",
"guardian_2_name": "Jane Doe",
"guardian_2_phone": "+35891234",
"hcp": "13.0",
"height": 178,
"id": 1234,
"invoicing_info": null,
"joined_at": "2014-01-01",
"last_name": "Doe",
"last_request_at": null,
"left_at": null,
"locale": "fi",
"member_invoicing_address": {"city": "Espoo",
"country": "Suomi",
"enabled": true,
"first_name": "Jane",
"last_name": "Doe",
"street": "Albergan puistotie",
"zip": "02600"
},
"notes": null,
"notifications": true,
"organisation": null,
"own_notes": null,
"phone": "+24591234",
"photography_permission": true,
"street": "Albergan puistotie",
"terms_accepted": false,
"updated_at": "2014-11-12T11:20:55+02:00",
"week_mail": true,
"weight": "76.0",
"zip": "02600",
"memberships": [ ],
"custom_values": [{"title": "Pelipaikka",
"data_type": "multilist",
"value": ["Maalivahti"
]
},
{"title": "Boolean",
"data_type": "boolean",
"value": false
}
],
"invoices": [{"due_amount": "25.0",
"due_date": "2015-10-23",
"id": 101,
"member_id": 1234,
"status": "open"
},
{"due_amount": "12.0",
"due_date": "2015-10-25",
"id": 102,
"member_id": 1234,
"status": "paid",
"starts_at": "2015-10-25T11:00:00.000+03:00",
"ends_at": null,
"event_id": 110,
"event_name": "Training"
}
],
"avatars": {"mini": "https://..../8989-32fe945fc0d6ed5efa499f08b35e67914f16bd81-mini.jpg",
"small": "https://..../8989-32fe945fc0d6ed5efa499f08b35e67914f16bd81-small.jpg",
"medium": "https://..../8989-32fe945fc0d6ed5efa499f08b35e67914f16bd81-medium.jpg",
"original": "https://..../8989-32fe945fc0d6ed5efa499f08b35e67914f16bd81-original.jpg"
},
"public_fields": ["first_name",
"last_name",
"phone"
],
"public_custom_fields": ["Pelipaikka"
]
}
}

Find by name

Finds member by name, names must match exactly.

Authorizations:

ApiToken

query Parameters

first_name required	string
last_name required	string

Responses

Response samples

200

Content type

application/json

{"member": {"active": true,
"birthday": "1990-01-01",
"business": false,
"city": "Espoo",
"clothing_size": "M",
"club_id": 9,
"coach": false,
"competition_number": "42",
"confirmed": false,
"country": "Suomi",
"created_at": "2014-11-12T11:02:26+02:00",
"default_group_id": null,
"email": "john.doe@spam.com",
"email_2": "jack.doe@spam.com",
"email_3": "jane.doe@spam.com",
"email_confirmations": true,
"external_license_id": "007",
"first_name": "John",
"gender": "male",
"guardian_1_name": "Jack Doe",
"guardian_1_phone": "+35891234",
"guardian_2_name": "Jane Doe",
"guardian_2_phone": "+35891234",
"hcp": "13.0",
"height": 178,
"hetu": "010190-126J",
"id": 1234,
"import_id": null,
"invoicing_info": null,
"joined_at": "2014-01-01",
"last_name": "Doe",
"last_request_at": null,
"left_at": null,
"locale": "fi",
"notes": null,
"organisation": null,
"own_notes": null,
"owner": false,
"phone": "+24591234",
"photography_permission": true,
"street": "Albergan puistotie",
"terms_accepted": false,
"updated_at": "2014-11-12T11:20:55+02:00",
"week_mail": true,
"weight": "76.0",
"zip": "02600",
"memberships": [ ],
"custom_values": [{"title": "Pelipaikka",
"data_type": "multilist",
"value": ["Maalivahti"
]
},
{"title": "Boolean",
"data_type": "boolean",
"value": false
}
],
"avatars": {"mini": "https://..../8989-32fe945fc0d6ed5efa499f08b35e67914f16bd81-mini.jpg",
"small": "https://..../8989-32fe945fc0d6ed5efa499f08b35e67914f16bd81-small.jpg",
"medium": "https://..../8989-32fe945fc0d6ed5efa499f08b35e67914f16bd81-medium.jpg",
"original": "https://..../8989-32fe945fc0d6ed5efa499f08b35e67914f16bd81-original.jpg"
},
"public_fields": ["first_name",
"last_name",
"phone"
],
"public_custom_fields": ["Pelipaikka"
]
}
}

Create membership

Adds the member to a group or updates an existing membership.

Authorizations:

ApiToken

path Parameters

group_id required	number ID of the group
member_id required	number ID of the member

Request Body schema: application/json

level

string

Level for the member, if omitted, level information is not set and will also be removed from existing membership.

Responses

Request samples

Payload

Content type

application/json

{"level": "Maalivahti"
}

Response samples

200

Content type

application/json

{"message": "ok"
}

Remove membership

Removes member from the given group

Authorizations:

ApiToken

path Parameters

group_id required	number ID of the group
member_id required	number ID of the member

Responses

Response samples

200

Content type

application/json

{"message": "ok"
}

Invoices

Create invoice

Returns id of newly created invoice

Authorizations:

ApiToken

Request Body schema: application/json

object

Invoice

Responses

Request samples

Payload

Content type

application/json

{"invoice": {"bank_account_id": 9,
"due_date": "2014-12-01",
"group_id": 34,
"member_id": 171,
"invoice_lines": [{"category_id": 57,
"gross_unit_price": "250.0",
"net_unit_price": "200.0",
"number": 100,
"quantity": "1.0",
"title": "Jääkiekkolasku",
"vat_percent": "25.0"
}
]
}
}

Response samples

200

Content type

application/json

113

Show invoice

Authorizations:

ApiToken

path Parameters

id

required

number

ID of the invoice

Responses

Response samples

200

Content type

application/json

{"invoice": {"bank_account_id": 9,
"comments": null,
"created_at": "2014-11-11T14:48:12+02:00",
"currency": "EUR",
"delivered": false,
"due_amount": "120.0",
"due_date": "2014-11-25",
"e_invoice_sent_at": null,
"event_id": null,
"formatted_reference": "2859",
"group_id": 43,
"id": 113,
"internal_comment": "",
"issued_on": null,
"last_payment_entered_on": "2014-11-11",
"last_payment_on": "2014-11-11",
"message": "",
"paid_amount": "120.0",
"payment_term_days": 14,
"penal_interest": "11.5",
"reference": "2859",
"reference_prefix": null,
"status_id": "draft",
"updated_at": "2014-11-11T14:49:21+02:00",
"member_ext_id": 171,
"invoice_lines": [{"category_id": 57,
"created_at": "2014-11-11T14:48:12+02:00",
"editable": true,
"gross_unit_price": "120.0",
"id": 134,
"net_unit_price": "120.0",
"number": 100,
"product_id": null,
"quantity": "1.0",
"title": "Jäämaksu",
"updated_at": "2014-11-11T14:49:21+02:00",
"vat_percent": "0.0"
}
],
"payments": [{"amount": "120.0",
"bank_account_id": null,
"comment": "Käteismaksu",
"created_at": "2014-11-11T14:49:21+02:00",
"creator_id": 2170,
"entry_date": "2014-11-11",
"filing_code": "Simo Aho ti 11 marras 14",
"payer": null,
"payment_date": "2014-11-11",
"payment_import_id": null,
"reference": null,
"updated_at": "2014-11-11T14:49:21+02:00",
"visible": true,
"payment_method": "cash"
}
]
}
}

Deliver invoice

Issues and delivers invoice to member

Authorizations:

ApiToken

path Parameters

id

required

number

ID of the invoice

Responses

Response samples

200

Content type

application/json

"ok"

Notifications

List notifications

Lists notifications in given groups or all.

Authorizations:

ApiToken

query Parameters

group_id	number
group_ids	Array of integers Array of group ids to search notifications from. If blank, return all.
visibility	string Enum: "all" "group" "public" Filter notifications by visibility. Defaults to all.

Responses

Response samples

200

Content type

application/json

[{"notification": {"id": 22,
"group_id": 10,
"subject": "Rules of conduct",
"details_html": "<ul><li>Be nice</li><li>Help each other</li></ul>",
"published_at": null,
"expires_at": null,
"updated_at": "2020-05-30T13:00:00.000+03:00",
"allow_comments": true,
"visibility": "public",
"attachments": [{"id": 1,
"file_name": "notes.pdf",
"url": "http://club.myclub.fi/attachments/1",
"content_type": "application/pdf"
}
],
"photo_small": "https://myclub.s3-eu-central-1.amazonaws.com/notification_photos/2",
"photo_original": "https://myclub.s3-eu-central-1.amazonaws.com/notification_photos/3"
}
},
{"notification": {"id": 24,
"group_id": 5,
"subject": "Team announcement",
"details_html": "<p>End of season party during next week end! Join the fun!</p>",
"published_at": "2020-05-24T00:00:00.000+03:00",
"expires_at": "2020-05-31T00:00:00.000+03:00",
"updated_at": "2020-05-30T13:00:00.000+03:00",
"allow_comments": true,
"visibility": "group",
"attachments": [ ],
"photo_small": null,
"photo_original": null
}
}
]

Create notification

Authorizations:

ApiToken

Request Body schema: application/json

object

Notification

Responses

Request samples

Payload

Content type

application/json

{"notification": {"group_id": 10,
"subject": "Rules of conduct",
"details": "<ul><li>Be nice</li><li>Help each other</li></ul>",
"published_at": "2020-05-24T00:00:00.000+03:00",
"expires_at": "2020-05-31T00:00:00.000+03:00",
"allow_comments": true,
"visibility": "public"
}
}

Response samples

200

Content type

application/json

{"notification": {"id": 22,
"group_id": 10,
"subject": "Rules of conduct",
"details_html": "<ul><li>Be nice</li><li>Help each other</li></ul>",
"published_at": "2020-05-24T00:00:00.000+03:00",
"expires_at": "2020-05-31T00:00:00.000+03:00",
"updated_at": "2020-05-30T13:00:00.000+03:00",
"allow_comments": true,
"visibility": "public",
"attachments": [ ],
"photo_small": null,
"photo_original": null
}
}

Show notification

Authorizations:

ApiToken

path Parameters

id

required

number

ID of the Notification

Responses

Response samples

200

Content type

application/json

{"notification": {"id": 22,
"group_id": 10,
"subject": "Rules of conduct",
"details_html": "<ul><li>Be nice</li><li>Help each other</li></ul>",
"published_at": "2020-05-24T00:00:00.000+03:00",
"expires_at": "2020-05-31T00:00:00.000+03:00",
"updated_at": "2020-05-30T13:00:00.000+03:00",
"allow_comments": true,
"visibility": "public",
"attachments": [{"id": 1,
"file_name": "notes.pdf",
"url": "http://club.myclub.fi/attachments/1",
"content_type": "application/pdf"
}
],
"photo_small": "https://myclub.s3-eu-central-1.amazonaws.com/notification_photos/2",
"photo_original": "https://myclub.s3-eu-central-1.amazonaws.com/notification_photos/3"
}
}

Update notification

Authorizations:

ApiToken

path Parameters

id

required

number

ID of the Notification

Request Body schema: application/json

object

Notification

Responses

Request samples

Payload

Content type

application/json

{"notification": {"subject": "Updated rules of conduct"
}
}

Response samples

200

Content type

application/json

{"notification": {"id": 22,
"group_id": 10,
"subject": "Updated rules of conduct",
"details_html": "<ul><li>Be nice</li><li>Help each other</li></ul>",
"published_at": "2020-05-24T00:00:00.000+03:00",
"expires_at": "2020-05-31T00:00:00.000+03:00",
"updated_at": "2020-05-30T13:00:00.000+03:00",
"allow_comments": true,
"visibility": "public",
"attachments": [{"id": 1,
"file_name": "notes.pdf",
"url": "http://club.myclub.fi/attachments/1",
"content_type": "application/pdf"
}
],
"photo_small": "https://myclub.s3-eu-central-1.amazonaws.com/notification_photos/2",
"photo_original": "https://myclub.s3-eu-central-1.amazonaws.com/notification_photos/3"
}
}

Delete notification

Authorizations:

ApiToken

path Parameters

id

required

number

ID of the Notification

Responses

Response samples

200

Content type

application/json

"ok"

Groups

List groups

Lists all groups for the club. Group is needed when creating events or invoices.

Authorizations:

ApiToken

Responses

Response samples

200

Content type

application/json

[{"group": {"description_html": "<h1>Hockey team</h1><p>This team loves to play hockey</p>",
"display_order": 1,
"email": "myclub.demo@gmail.com",
"id": 34,
"kind_ids": [2,
25
],
"level_set_id": 33,
"name": "Jääkiekkojaos",
"parent_id": 33,
"updated_at": "2013-08-27T13:15:06+03:00",
"photo_small": "https://myclub.s3-eu-central-1.amazonaws.com/group_photos/1",
"photo_original": "https://myclub.s3-eu-central-1.amazonaws.com/group_photos/2"
}
},
{"group": {"description_html": null,
"display_order": 2,
"email": "myclub.demo@gmail.com",
"id": 35,
"kind_ids": [ ],
"level_set_id": 34,
"name": "F-juniorit",
"parent_id": 34,
"updated_at": "2013-08-27T13:15:06+03:00",
"photo_small": null,
"photo_original": null
}
}
]

Get memberships of group

Returns a list of all memberships in the group. Membership includes member level and member id. The level of membership can only be shown publicly if the member's public_fields element contains the identifier "level".

Authorizations:

ApiToken

path Parameters

id

required

number

Responses

Response samples

200

Content type

application/json

[{"membership": {"group_id": 211,
"member_id": 87338,
"created_at": "2011-12-15T11:07:45+02:00",
"updated_at": "2011-12-15T11:07:47+02:00",
"level": "Pelaaja",
"level_display_order": 1
}
},
{"membership": {"group_id": 211,
"member_id": 87346,
"created_at": "2011-12-15T11:07:46+02:00",
"updated_at": "2011-12-15T11:07:47+02:00",
"level": "Pelaaja",
"level_display_order": 1
}
}
]

List levels

Returns a list of membership levels used in the group. Needed when creating new members.

Authorizations:

ApiToken

path Parameters

id

required

number

Responses

Response samples

200

Content type

application/json

["Kannattajajäsen",
"Jäsen",
"Valmennuspäälikkö",
"Kunniajäsen",
"Hallituksen jäsen",
"Hallituksen puheenjohtaja"
]

List levels details

Returns a list of membership levels used in the group with details.

Authorizations:

ApiToken

path Parameters

id

required

number

Responses

Response samples

200

Content type

application/json

[{"level": {"id": 1,
"name": "Kannattajajäsen",
"level_set_id": 3,
"description": "Sponsorit",
"sort_order": 2,
"color": "#ff0000"
}
},
{"level": {"id": 2,
"name": "Jäsen",
"level_set_id": 3,
"description": "Varsinainen jäsen",
"sort_order": 3,
"color": "#00dd00"
}
}
]

Contracts

List contracts

Shows contracts in the club

Authorizations:

ApiToken

query Parameters

member_id

number

Id of member for which contracts should be returned

Responses

Response samples

200

Content type

application/json

[{"contract": {"bank_account_id": 1,
"contract_service_id": 4,
"contractee_city": "Wuppertal",
"contractee_email": "demo@clubway.de",
"contractee_first_name": "Demo",
"contractee_last_name": "Member",
"contractee_phone": "0501234567",
"contractee_street": "Demo street",
"contractee_zip": "12345",
"deferred_periods": [{"contract_id": 20,
"ends_on": "2023-04-22",
"id": 15,
"starts_on": "2023-04-19"
}
],
"ext_id": 103,
"extension_length": null,
"extension_notice_period": null,
"flag": false,
"group_id": 6,
"id": 20,
"invoice_day": "first",
"invoiced_periods": [{"contract_id": 20,
"id": 50,
"invoiced_amount": "75.0",
"invoiced_from": "2023-03-02",
"invoiced_to": "2023-04-01"
},
{"contract_id": "20,",
"id": 51,
"invoiced_amount": "65.0",
"invoiced_from": "2023-04-02",
"invoiced_to": "2023-05-01"
}
],
"invoicing_period_length": 1,
"member_id": 12,
"notes": null,
"notice_period": null,
"notice_period_type": null,
"recurring": false,
"startup_fee": "24.9",
"unit_price": "75.0",
"terminated_on": null,
"terminates_on": null,
"valid_from": "2023-03-02",
"valid_until": "2023-06-01",
"validity_period_type": "rolling",
"vat_percent": "0.0"
}
}
]

Create contracts

Create a contract.

Authorizations:

ApiToken

Request Body schema: application/json

object

Contract

Responses

Request samples

Payload

Content type

application/json

{"contract": {"bank_account_id": 10,
"contract_service_id": 2,
"contractee_city": "Berlin",
"contractee_email": "mail@clubway.de",
"contractee_first_name": "John",
"contractee_last_name": "Doe",
"contractee_phone": "123456789",
"contractee_street": "Street 1",
"contractee_zip": "12345",
"extension_length": 1,
"extension_notice_period": 1,
"flag": false,
"group_id": 33,
"invoice_day": "last",
"invoicing_period_length": 1,
"member_id": 129,
"notes": "Some notes",
"notice_period": 1,
"notice_period_type": "from_termination",
"recurring": true,
"startup_fee": 19.9,
"unit_price": 76,
"valid_from": "2023-03-02",
"valid_until": "2023-06-01",
"validity_period_type": "rolling",
"vat_percent": 0
}
}

Response samples

200

Content type

application/json

{"contract": {"bank_account_id": 10,
"contract_service_id": 2,
"contractee_city": "Wuppertal",
"contractee_email": "demo@clubway.de",
"contractee_first_name": "Demo",
"contractee_last_name": "Member",
"contractee_phone": "0501234567",
"contractee_street": "Demo street",
"contractee_zip": "12345",
"deferred_periods": [ ],
"ext_id": 102,
"extension_length": 1,
"extension_notice_period": 1,
"flag": false,
"group_id": 33,
"id": 21,
"invoice_day": "last",
"invoiced_periods": [ ],
"invoicing_period_length": 1,
"member_id": 129,
"notes": "Some notes",
"notice_period": 1,
"notice_period_type": "from_termination",
"recurring": true,
"startup_fee": "19.9",
"unit_price": "100.0",
"terminated_on": null,
"terminates_on": null,
"valid_from": "2023-03-02",
"valid_until": "2023-06-01",
"validity_period_type": "rolling",
"vat_percent": "0.0"
}
}

List contract services

Shows contract services defined by the club

Authorizations:

ApiToken

Responses

Response samples

200

Content type

application/json

[{"contract_service": {"extension_length": 1,
"extension_notice_period": 1,
"id": 5,
"invoice_day": "first",
"invoicing_periods": [{"contract_service_id": 5,
"id": 1,
"period_length": 1,
"unit_price": "100.0"
},
{"contract_service_id": 5,
"id": 2,
"period_length": 6,
"unit_price": "90.0"
}
],
"name": "Junior membership,",
"notice_period": 1,
"notice_period_type": "from_termination",
"recurring": true,
"startup_fee": "15.9",
"validity_period_length": 1,
"validity_period_start_month": null,
"validity_period_type": "rolling",
"vat_percent": "0.0"
}
},
{"contract_service": {"extension_length": null,
"extension_notice_period": null,
"id": 26,
"invoice_day": "middle",
"invoicing_periods": [{"contract_service_id": 26,
"id": 3,
"period_length": 12,
"unit_price": "329.9"
}
],
"name": "Yearly membership",
"notice_period": null,
"notice_period_type": null,
"recurring": false,
"startup_fee": "0.0",
"validity_period_length": 12,
"validity_period_start_month": 10,
"validity_period_type": "fixed",
"vat_percent": "0.0"
}
}
]

Club

Show basic information of club

Return details for the club.

Authorizations:

ApiToken

Responses

Response samples

200

Content type

application/json

{"club": {"name": "Demo Club",
"street": "Example Street 5",
"zip": "000000",
"city": "Capitol City",
"email": "email@democlub.com",
"description": "Club for all sports.",
"logo": {"url": "http://image.png",
"content_type": "image/png"
},
"invoicing_details": {"reference": "Contact Person",
"street": "Example Street 5",
"zip": "000000",
"city": "Capitol City",
"e_invoice_address": "0506845840"
}
}
}

Web Shop

Club must have web shop add-on

Api member must have owner or shop manager role

List web shop orders

Returned collection is limited to 100 records.

Authorizations:

ApiToken

query Parameters

since

string <date-time>

Date of which to start listing orders. If empty returns all.

Responses

Response samples

200

Content type

application/json

{"order": {"member_id": 123,
"invoice_id": 456,
"status": "open",
"ext_id": 789,
"created_at": "2021-04-16T15:06:09.000+03:00",
"comment": "",
"delivered_at": null,
"internal_comment": null,
"first_name": "John",
"last_name": "Doe",
"street": "Street 4",
"zip": "12345",
"city": "Helsinki",
"email": "john.doe@mail.com",
"phone": null,
"lines": [{"quantity": 10,
"comment": "",
"product": {"id": 5,
"visible_name": "Club Shirt L"
}
}
]
}
}

Other

List bank accounts

Shows bank accounts defined by the club

Authorizations:

ApiToken

Responses

Response samples

200

Content type

application/json

[{"bank_account": null,
"bic": "OKOYFIHH",
"display_order": 0,
"iban": "FI8650000120008123",
"id": 9,
"name": "Perustili",
"online_payments": true,
"receiver_address": null,
"receiver_email": null,
"receiver_name": "Demo-Seura"
},
{"bank_account": null,
"bic": "AABAFI22",
"display_order": 0,
"iban": "FI3866010001186123",
"id": 10,
"name": "Toinen tili",
"online_payments": true,
"receiver_address": "Linnoitustie 4A\r\n02600 Espoo",
"receiver_email": "myclub.demo@gmail.com",
"receiver_name": "Demo Seura Ry"
}
]

List card products

Shows card products defined by the club

Authorizations:

ApiToken

Responses

Response samples

200

Content type

application/json

[{"card_product": {"id": 10,
"name": "Season card 2019",
"valid_from": "2019-01-01",
"valid_until": "2019-06-30",
"days_valid": null,
"usage_times": null,
"gross_unit_price": "155.0",
"vat_percent": "0.0"
}
},
{"card_product": {"id": 11,
"name": "10 times card",
"valid_from": null,
"valid_until": null,
"days_valid": 90,
"usage_times": 10,
"gross_unit_price": "39.9",
"vat_percent": "0.0"
}
}
]

List custom fields

Shows custom fields defined by the club

Authorizations:

ApiToken

Responses

Response samples

200

Content type

application/json

[{"custom_field": {"data_type": "integer",
"decimal_count": null,
"display_order": 100,
"id": 10,
"instructions": null,
"member_editable": true,
"member_visible": true,
"name": "Shoe size",
"status": "registration",
"value_set": null
}
},
{"custom_field": {"data_type": "multilist",
"decimal_count": null,
"display_order": 110,
"id": 11,
"instructions": null,
"member_editable": true,
"member_visible": true,
"name": "Play positions",
"status": "visible",
"value_set": "Defender\nMidfielder\nAttacker"
}
}
]

List event categories

List all event categories for club.

Authorizations:

ApiToken

Responses

Response samples

200

Content type

application/json

[{"event_category": {"id": 411,
"color": "#ff0000",
"name": "Training"
}
},
{"event_category": {"id": 412,
"color": "#959595",
"name": "Tournament"
}
},
{"event_category": {"id": 413,
"color": "#446688",
"name": "Match"
}
}
]

List invoicing categories

Shows invoicing categories that can be used to categorize invoice lines

Authorizations:

ApiToken

Responses

Response samples

200

Content type

application/json

[{"invoicing_category": {"display_order": 100,
"id": 57,
"name": "Jäsenmaksut"
}
},
{"invoicing_category": {"display_order": 110,
"id": 58,
"name": "Kurssimaksut"
}
},
{"invoicing_category": {"display_order": 120,
"id": 59,
"name": "Kausimaksut"
}
},
{"invoicing_category": {"display_order": 140,
"id": 60,
"name": "Vakuutusmaksut"
}
},
{"invoicing_category": {"display_order": 130,
"id": 61,
"name": "Kenttämaksut"
}
},
{"invoicing_category": {"display_order": 150,
"id": 62,
"name": "Varustemaksut"
}
},
{"invoicing_category": {"display_order": 160,
"id": 63,
"name": "Muu"
}
}
]

List kinds (sports)

Shows sports available for clubs and groups

Authorizations:

ApiToken

Responses

Response samples

200

Content type

application/json

[{"kind": {"id": 3,
"name": "Basketball"
}
},
{"kind": {"id": 12,
"name": "Swimming"
}
}
]

List venues

Lists all venues for the club. Used when creating an event an assigning a venue to that event

Authorizations:

ApiToken

Responses

Response samples

200

Content type

application/json

[{"venue": {"city": "Espoo",
"club_id": 9,
"country": "Suomi",
"created_at": "2013-08-27T13:15:00+03:00",
"id": 81,
"map_link": null,
"name": "Kannusillanmäen väestönsuoja",
"street": "Kannusillankatu 4",
"updated_at": "2013-08-27T13:15:00+03:00",
"web_link": null,
"zip": "02770"
}
},
{"venue": {"city": "Espoo",
"club_id": 9,
"country": "Suomi",
"created_at": "2013-08-27T13:15:00+03:00",
"id": 82,
"map_link": null,
"name": "Espoonlahden urheiluhalli",
"street": "Rehtorintie 11",
"updated_at": "2013-08-27T13:15:00+03:00",
"web_link": null,
"zip": "02320"
}
}
]

List rosters

Lists all roster visible to the api member. Rosters can be used to filter members in the members index endpoint with query parameter roster_ids.

Authorizations:

ApiToken

Responses

Response samples

200

Content type

application/json

[{"roster": {"created_at": "2013-08-27T13:15:00+03:00",
"group_id": 2,
"id": 10,
"name": "Club members",
"shared": true,
"updated_at": "2013-08-27T13:15:00+03:00"
}
},
{"roster": {"created_at": "2013-08-27T13:15:00+03:00",
"group_id": 3,
"id": 12,
"name": "Juniors",
"shared": false,
"updated_at": "2013-08-27T13:15:00+03:00"
}
}
]

Event Embeds

List event embeds

Lists event embeds in given groups or all.

Authorizations:

ApiToken

query Parameters

group_ids

Array of integers

array of group ids to search embeds from. If blank, return all.

Responses

Response samples

200

Content type

application/json

[{"event_embed": {"id": 554,
"name": "League games",
"group_id": 25,
"default_mode": "month",
"visibility": "all",
"visibilities": ["group",
"club",
"public"
],
"registration": "all",
"components": null,
"max_amount": 20,
"max_weeks": null,
"embed_style_id": null,
"hide_filters": true,
"show_sub_groups": false,
"subscription_enabled": null,
"default_locale": "fi",
"category_ids": [13
],
"venue_ids": null,
"ics_link": "https://download-feed.myclub.fi/events.ics",
"embed_url": "https://link-to-embed.myclub.fi"
}
},
{"event_embed": {"id": 555,
"name": "Training",
"group_id": 35,
"default_mode": "list",
"visibility": "group",
"visibilities": ["group"
],
"registration": "group",
"components": null,
"max_amount": null,
"max_weeks": null,
"embed_style_id": 7,
"hide_filters": false,
"show_sub_groups": true,
"subscription_enabled": null,
"default_locale": "fi",
"category_ids": [16
],
"venue_ids": null,
"ics_link": "https://download-feed.myclub.fi/events2.ics",
"embed_url": "https://link-to-embed2.myclub.fi"
}
}
]

Create event embed

Authorizations:

ApiToken

Request Body schema: application/json

object

Event Embed

Responses

Request samples

Payload

Content type

application/json

{"event_embed": {"name": "League games",
"group_id": 25,
"default_mode": "month",
"visibility": ["group",
"club",
"public"
],
"registration": "all",
"max_amount": 20,
"hide_filters": true,
"show_sub_groups": false,
"default_locale": "fi",
"category_ids": [13
]
}
}

Response samples

200

Content type

application/json

{"event_embed": {"id": 554,
"name": "League games",
"group_id": 25,
"default_mode": "month",
"visibility": "all",
"visibilities": ["group",
"club",
"public"
],
"registration": "all",
"components": null,
"max_amount": 20,
"max_weeks": null,
"embed_style_id": null,
"hide_filters": true,
"show_sub_groups": false,
"subscription_enabled": null,
"default_locale": "fi",
"category_ids": [13
],
"venue_ids": null,
"ics_link": "https://download-feed.myclub.fi/events.ics",
"embed_url": "https://link-to-embed.myclub.fi"
}
}

Show event embed

Authorizations:

ApiToken

path Parameters

id

required

number

Responses

Response samples

200

Content type

application/json

{"event_embed": {"id": 554,
"name": "League games",
"group_id": 25,
"default_mode": "custom",
"visibility": "all",
"visibilities": ["group",
"club",
"public"
],
"registration": "group",
"components": ["indication_info",
"indication_amounts"
],
"max_amount": 20,
"max_weeks": 4,
"embed_style_id": 23,
"hide_filters": true,
"show_sub_groups": false,
"subscription_enabled": null,
"default_locale": "fi",
"category_ids": [13
],
"venue_ids": [98,
104,
224
],
"ics_link": "https://download-feed.myclub.fi/events.ics",
"embed_url": "https://link-to-embed.myclub.fi"
}
}

Update event embed

Authorizations:

ApiToken

path Parameters

id

required

number

Request Body schema: application/json

object

Event Embed

Responses

Request samples

Payload

Content type

application/json

{"event_embed": {"default_mode": "custom",
"components": ["indication_info",
"indication_amounts"
]
}
}

Response samples

200

Content type

application/json

{"event_embed": {"id": 554,
"name": "League games",
"group_id": 25,
"default_mode": "custom",
"visibility": "all",
"visibilities": ["group",
"club",
"public"
],
"registration": "group",
"components": ["indication_info",
"indication_amounts"
],
"max_amount": 20,
"max_weeks": 4,
"embed_style_id": 23,
"hide_filters": true,
"show_sub_groups": false,
"subscription_enabled": null,
"default_locale": "fi",
"category_ids": [13
],
"venue_ids": [98,
104,
224
],
"ics_link": "https://download-feed.myclub.fi/events.ics",
"embed_url": "https://link-to-embed.myclub.fi"
}
}

Delete event embed

Authorizations:

ApiToken

path Parameters

id

required

number

Responses

Response samples

200

Content type

application/json

"ok"

Course Embeds

List course embeds

Lists course embeds in given groups or all.

Authorizations:

ApiToken

query Parameters

group_ids

Array of integers

array of group ids to search embeds from. If blank, return all.

Responses

Response samples

200

Content type

application/json

[{"course_embed": {"id": 554,
"name": "League games",
"group_id": 25,
"default_mode": "list",
"visibility": "all",
"registration": "all",
"max_weeks": null,
"embed_style_id": null,
"hide_filters": true,
"show_sub_groups": false,
"default_locale": "fi",
"category_ids": [13
],
"venue_ids": null,
"embed_url": "https://link-to-embed.myclub.fi"
}
},
{"course_embed": {"id": 555,
"name": "Training",
"group_id": 35,
"default_mode": "list",
"visibility": "group",
"registration": "group",
"max_weeks": null,
"embed_style_id": 7,
"hide_filters": false,
"show_sub_groups": true,
"default_locale": "fi",
"category_ids": [16
],
"venue_ids": null,
"embed_url": "https://link-to-embed2.myclub.fi"
}
}
]

Create course embed

Authorizations:

ApiToken

Request Body schema: application/json

object

course Embed

Responses

Request samples

Payload

Content type

application/json

{"course_embed": {"name": "League games",
"group_id": 25,
"default_mode": "list",
"visibility": "all",
"registration": "all",
"hide_filters": true,
"show_sub_groups": false,
"default_locale": "fi",
"category_ids": [13
]
}
}

Response samples

200

Content type

application/json

{"course_embed": {"id": 554,
"name": "League games",
"group_id": 25,
"default_mode": "list",
"visibility": "all",
"registration": "all",
"max_weeks": null,
"embed_style_id": null,
"hide_filters": true,
"show_sub_groups": false,
"default_locale": "fi",
"category_ids": [13
],
"venue_ids": null,
"embed_url": "https://link-to-embed.myclub.fi"
}
}

Show course embed

Authorizations:

ApiToken

path Parameters

id

required

number

Responses

Response samples

200

Content type

application/json

{"course_embed": {"id": 554,
"name": "League games",
"group_id": 25,
"default_mode": "list",
"visibility": "all",
"registration": "group",
"max_weeks": 4,
"embed_style_id": 23,
"hide_filters": true,
"show_sub_groups": false,
"default_locale": "fi",
"category_ids": [13
],
"venue_ids": [98,
104,
224
],
"embed_url": "https://link-to-embed.myclub.fi"
}
}

Update course embed

Authorizations:

ApiToken

path Parameters

id

required

number

Request Body schema: application/json

object

course Embed

Responses

Request samples

Payload

Content type

application/json

{"course_embed": {"default_mode": "cards",
"name": "League 2022-2023"
}
}

Response samples

200

Content type

application/json

{"course_embed": {"id": 554,
"name": "League 2022-2023",
"group_id": 25,
"default_mode": "cards",
"visibility": "all",
"registration": "group",
"max_weeks": 4,
"embed_style_id": 23,
"hide_filters": true,
"show_sub_groups": false,
"default_locale": "fi",
"category_ids": [13
],
"venue_ids": [98,
104,
224
],
"embed_url": "https://link-to-embed.myclub.fi"
}
}

Delete course embed

Authorizations:

ApiToken

path Parameters

id

required

number

Responses

Response samples

200

Content type

application/json

"ok"

Member Embeds

List member embeds

Lists member embeds in given groups or all.

Authorizations:

ApiToken

query Parameters

group_ids

Array of integers

array of group ids to search embeds from. If blank, return all.

Responses

Response samples

200

Content type

application/json

[{"member_embed": {"id": 73,
"name": "Staff",
"group_id": 67,
"default_mode": "list_with_images",
"max_amount": 10,
"category_ids": [12
],
"default_locale": "fi",
"embed_url": "https://link-to-embed.myclub.fi",
"active_visible_fields": [ ],
"active_promoted_fields": [ ]
}
},
{"member_embed": {"id": 122,
"name": "Players",
"group_id": 67,
"default_mode": "list_with_images",
"max_amount": 30,
"category_ids": [22,
23
],
"default_locale": "fi",
"embed_url": "https://link-to-embed.myclub.fi",
"active_visible_fields": [ ],
"active_promoted_fields": [ ]
}
}
]

Create member embed

Authorizations:

ApiToken

Request Body schema: application/json

object

Member Embed

Responses

Request samples

Payload

Content type

application/json

{"member_embed": {"name": "Staff",
"group_id": 67,
"default_mode": "list_with_images",
"max_amount": 10,
"category_ids": [12
],
"default_locale": "fi",
"extra_settings": {"grouped_by": "level",
"visible_fields": ["height",
"weight",
"3",
"email"
],
"promoted_fields": ["avatar",
"first_name",
"last_name",
"competition_number"
],
"sorted_by": ["level",
"last_name"
]
}
}
}

Response samples

200

Content type

application/json

{"member_embed": {"id": 73,
"name": "Staff",
"group_id": 67,
"default_mode": "list_with_images",
"max_amount": 10,
"category_ids": [12
],
"default_locale": "fi",
"embed_url": "https://link-to-embed.myclub.fi",
"active_visible_fields": ["height",
"3",
"email"
],
"active_promoted_fields": ["avatar",
"first_name",
"last_name",
"competition_number"
],
"sorted_by": ["level",
"last_name"
],
"grouped_by": "level"
}
}

Show member embed

Authorizations:

ApiToken

path Parameters

id

required

number

Responses

Response samples

200

Content type

application/json

{"member_embed": {"id": 73,
"name": "Staff",
"group_id": 67,
"default_mode": "list_with_images",
"max_amount": 10,
"category_ids": [12
],
"default_locale": "fi",
"embed_url": "https://link-to-embed.myclub.fi",
"active_visible_fields": ["height",
"3",
"email"
],
"active_promoted_fields": ["avatar",
"first_name",
"last_name",
"competition_number"
]
}
}

Update member embed

Authorizations:

ApiToken

path Parameters

id

required

number

Request Body schema: application/json

object

Event Embed

Responses

Request samples

Payload

Content type

application/json

{"member_embed": {"default_mode": "list"
}
}

Response samples

200

Content type

application/json

{"member_embed": {"id": 73,
"name": "Staff",
"group_id": 67,
"default_mode": "list",
"max_amount": 10,
"category_ids": [12
],
"default_locale": "fi",
"embed_url": "https://link-to-embed.myclub.fi",
"active_visible_fields": [ ],
"active_promoted_fields": [ ]
}
}

Delete member embed

Authorizations:

ApiToken

path Parameters

id

required

number

Responses

Response samples

200

Content type

application/json

"ok"

Notification Embeds

List notification embeds

Lists notification embeds in given groups or all.

Authorizations:

ApiToken

query Parameters

group_ids

Array of integers

array of group ids to search embeds from. If blank, return all.

Responses

Response samples

200

Content type

application/json

[{"notification_embed": {"id": 33,
"name": "News",
"group_id": 25,
"default_mode": "condensed",
"max_amount": 20,
"hide_filters": true,
"show_sub_groups": false,
"default_locale": "fi",
"embed_url": "https://link-to-embed.myclub.fi"
}
},
{"notification_embed": {"id": 122,
"name": "Team announcements",
"group_id": 2,
"default_mode": "list",
"max_amount": 10,
"hide_filters": false,
"show_sub_groups": false,
"default_locale": "fi",
"embed_url": "https://link-to-embed.myclub.fi"
}
}
]

Create notification embed

Authorizations:

ApiToken

Request Body schema: application/json

object

notification Embed

Responses

Request samples

Payload

Content type

application/json

{"notification_embed": {"name": "News",
"group_id": 25,
"default_mode": "condensed",
"max_amount": 20,
"hide_filters": true,
"show_sub_groups": false,
"default_locale": "fi"
}
}

Response samples

200

Content type

application/json

{"notification_embed": {"id": 33,
"name": "News",
"group_id": 25,
"default_mode": "condensed",
"max_amount": 20,
"hide_filters": true,
"show_sub_groups": false,
"default_locale": "fi",
"embed_url": "https://link-to-embed.myclub.fi"
}
}

Show notification embed

Authorizations:

ApiToken

path Parameters

id

required

number

Responses

Response samples

200

Content type

application/json

{"notification_embed": {"id": 33,
"name": "News",
"group_id": 25,
"default_mode": "condensed",
"max_amount": 20,
"hide_filters": true,
"show_sub_groups": false,
"default_locale": "fi",
"embed_url": "https://link-to-embed.myclub.fi"
}
}

Update notification embed

Authorizations:

ApiToken

path Parameters

id

required

number

Request Body schema: application/json

object

notification Embed

Responses

Request samples

Payload

Content type

application/json

{"notification_embed": {"default_mode": "list"
}
}

Response samples

200

Content type

application/json

{"notification_embed": {"id": 33,
"name": "News",
"group_id": 25,
"default_mode": "list",
"max_amount": 20,
"hide_filters": true,
"show_sub_groups": false,
"default_locale": "fi",
"embed_url": "https://link-to-embed.myclub.fi"
}
}

Delete notification embed

Authorizations:

ApiToken

path Parameters

id

required

number

Responses

Response samples

200

Content type

application/json

"ok"

Shop Product Embeds

List shop product embeds

Lists shop product embeds.

Authorizations:

ApiToken

Responses

Response samples

200

Content type

application/json

[{"shop_product_embed": {"id": 33,
"name": "Top 20 Products",
"max_amount": 20,
"default_locale": "fi",
"embed_url": "https://link-to-embed.myclub.fi"
}
},
{"shop_product_embed": {"id": 122,
"name": "All products",
"max_amount": null,
"default_locale": "fi",
"embed_url": "https://link-to-embed.myclub.fi"
}
}
]

Create shop product embed

Authorizations:

ApiToken

Request Body schema: application/json

object

shop-product Embed

Responses

Request samples

Payload

Content type

application/json

{"shop_product_embed": {"name": "Top 30 Products",
"max_amount": 30,
"default_locale": "fi"
}
}

Response samples

200

Content type

application/json

{"shop_product_embed": {"id": 33,
"name": "Top 30 Products",
"max_amount": 30,
"default_locale": "fi",
"embed_url": "https://link-to-embed.myclub.fi"
}
}

Show shop product embed

Authorizations:

ApiToken

path Parameters

id

required

number

Responses

Response samples

200

Content type

application/json

{"shop_product_embed": {"id": 33,
"name": "Top 30 Products",
"max_amount": 30,
"default_locale": "fi",
"embed_url": "https://link-to-embed.myclub.fi"
}
}

Update shop product embed

Authorizations:

ApiToken

path Parameters

id

required

number

Request Body schema: application/json

object

shop-product Embed

Responses

Request samples

Payload

Content type

application/json

{"shop_product_embed": {"name": "Top 20 Products",
"max_amount": 20
}
}

Response samples

200

Content type

application/json

{"shop_product_embed": {"id": 33,
"name": "Top 20 Products",
"max_amount": 20,
"default_locale": "fi",
"embed_url": "https://link-to-embed.myclub.fi"
}
}

Delete shop product embed

Authorizations:

ApiToken

path Parameters

id

required

number

Responses

Response samples

200

Content type

application/json

"ok"

Embed Styles

Keys for style

Key	Required	Description
`name`	X	Name of the style in UI
`custom_css`	*	Inline content for the stylesheet. Must be valid css. Required unless stylesheet_url is provided.
`stylesheet_url`	*	Url from which css stylesheet is loaded. Required unless custom_css is provided.

List embed styles

Lists embed styles.

Authorizations:

ApiToken

Responses

Response samples

200

Content type

application/json

[{"embed_style": null,
"name": "Blue theme",
"custom_css": " body { background-color: 'blue' } ",
"stylesheet_url": null
}
]

Create embed style

Either custom_css or stylesheet_url must be provided

Authorizations:

ApiToken

Request Body schema: application/json

object

Embed Style

Responses

Request samples

Payload

Content type

application/json

{"embed_style": {"name": "string",
"custom_css": "string",
"stylesheet_url": "string"
}
}

Response samples

200

Content type

application/json

{"embed_style": {"id": 0,
"name": "string",
"custom_css": "string",
"stylesheet_url": "string"
}
}

Show embed style

Authorizations:

ApiToken

path Parameters

id

required

number

Responses

Response samples

200

Content type

application/json

{"embed_style": {"name": "Blue theme",
"custom_css": " body { background-color: 'blue' } ",
"stylesheet_url": null
}
}

Update embed style

Authorizations:

ApiToken

path Parameters

id

required

number

Request Body schema: application/json

object

Embed Style

Responses

Request samples

Payload

Content type

application/json

{"embed_style": {"name": "Green theme",
"custom_css": " body { background-color: 'green' } "
}
}

Response samples

200

Content type

application/json

{"embed_style": {"name": "Green theme",
"custom_css": " body { background-color: 'green' } ",
"stylesheet_url": null
}
}

Delete embed style

Authorizations:

ApiToken

path Parameters

id

required

number

Responses

Response samples

200

Content type

application/json

"ok"