Connect Zapier
Read one page of your students in a zap with Webhooks by Zapier and a custom request, your key in the Authorization header.
You will read one page of your students in a zap, with the Webhooks by Zapier › Custom Request action: an address, a method and your key in a header.
A zap reads one page per run
You need a key that can read students, with Students › Read (students:read) ticked. If you do not have one, create it in the app, under Settings › Integrations › API keys: it is shown only once.
1. Pick a trigger
A zap starts with a trigger. Pick the one that fits your use: to test, a scheduled run is enough.
2. Add the Custom Request action
Add the Webhooks by Zapier › Custom Request action and fill in:
| Field | Value |
|---|---|
| Method | GET |
| URL | https://api.fitdistance.io/api/partner/v1/students?limit=50 |
| Headers | Authorization: Bearer fd_live_xxxxxxxx |
limit=50 is in the address. For Headers, add a header named Authorization whose value is Bearer fd_live_xxxxxxxx. Replace fd_live_xxxxxxxx with your key, keeping the word Bearer, a space, then your whole key. You do not need the other fields. The key is written in the action: do not share this zap with anyone who must not see it.
3. Test the step
Test the step: Zapier sends the call and shows the response of the API. This call needs the scope students:read and costs one credit, debited before the call. The response has three fields to know:
data: the students of this page, 50 at most.has_more:truewhen more pages remain.next_cursor: the marker of the next page.
A 401 UNAUTHORIZED means the key is missing, copied wrongly or revoked: check the word Bearer. A 403 SCOPE_MISSING means a scope is missing, and details.scope names it. Neither costs a credit. A refused parameter, such as limit=500, gives a 400 VALIDATION and costs a credit. Each test and each run of the zap costs one credit.
4. Know what the zap does not read
Each run reads one page, 50 students at most with limit=50. When has_more is true, more students exist and this zap does not read them. Set limit to 200, the maximum, in the address, for a bigger page: a page costs one credit, whatever its number of students.
To read all your students, use n8n or a script. Your key accepts 10 calls per second and 300 per minute: a 429 carries Retry-After, the number of seconds to wait, and costs nothing.
What next
The use cases detail complete automations; their steps are written for n8n and Make: an email for each new student, a reminder for students without a check-in, a reminder for inactive students and the other use cases on the home page. The two reminders send a message: their key must be able to write. The student fields are described in the reference.