For the complete documentation index, see llms.txt. This page is also available as Markdown.

Participants

Create a participant

post

Create a new participant record in your school.

Authorizations
AuthorizationstringRequired

Integration API key from Settings > API.

Body
first_namestringRequired
last_namestringOptional
emailstringOptional
phonestringOptional
birthdatestring · dateOptional

Date of birth (YYYY-MM-DD).

has_parentbooleanOptional

Whether this participant is a minor with a parent/guardian.

parent_first_namestringOptional

Parent/guardian's first name. Use for minors when has_parent is true.

parent_last_namestringOptional

Parent/guardian's last name. Use for minors when has_parent is true.

languagestringOptional

Preferred language code (e.g. "pl", "en").

Responses
201

Participant created. Returns the full participant object.

application/json
idintegerRequired
first_namestringOptional
last_namestringOptional
emailstring · nullableOptional
phonestring · nullableOptional
activebooleanOptional
balancestringOptional

Account balance as decimal string.

post/api/v1/participants

Search participants

post

Search for participants using filters.

Standard fields

Field
Type
Description

email

string

Participant's email address

phone

string

Participant's phone number

first_name

string

Participant's first name

last_name

string

Participant's last name

active

boolean

Whether the participant is currently active

Custom fields

Use field: custom with the custom field name configured in your school's settings. All custom field values are matched as strings.

Pagination

Results are ordered by id and paginated with a cursor. Pass the id of the last participant from the previous page as starting_after to fetch the next page. has_more tells you whether another page exists.

Authorizations
AuthorizationstringRequired

Integration API key from Settings > API.

Body
limitinteger · min: 1 · max: 100Optional

Number of participants to return per page.

Default: 25
starting_afterintegerOptional

Cursor for pagination - the id of the last participant on the previous page.

Responses
200

Participants matching the filters

application/json
has_morebooleanRequired

Whether more results exist beyond this page.

post/api/v1/participants/search

Ostatnia aktualizacja

Czy to było pomocne?