People to meet
This endpoint shows who else is going to an event. It works with a member token from Sign in with Crewcade. The token needs the people scope. An API key does not work here.
List the people going
Section titled “List the people going”GET /events/{id}/peoplePass the id of one date. The member must be going to that date with a confirmed signup. The member is not in the list.
| Query | Type | Meaning |
|---|---|---|
page | number | The page to read. Starts at 1. Default 1. |
pageSize | number | People per page. From 1 to 100. Default 20. |
The reply has these fields.
| Field | Meaning |
|---|---|
shown | false when the club hides the faces of attendees. Then data is empty. |
count | How many people are going. The event page shows the same number. |
data | The list of people. |
pagination | The page, the page size, the total and hasNext. |
Each event has a setting for who is going. Your app follows it.
- When the club shows faces, each person has a photo.
- When the club shows names only,
avatarUrlisnullfor everyone. - When the club shows a count only,
shownisfalse. - When fewer people go than the Show after number of the event,
shownisfalse. The club sets this number under Minimum to Display.countstill has the real number.
What each person has
Section titled “What each person has”| Field | Meaning |
|---|---|
memberId | The member id in this club. |
name | The name, by language code. nameText is one text. |
handle | The handle of the profile. Can be null. |
avatarUrl | The photo. Can be null. |
bio | The bio, by language code. bioText is one text. |
socialLinks | The social links. The club can hide some platforms. |
roles | The roles of the member in the club. |
properties | Answers to the member fields that the club shows to members. |
You never get an email address. You never get sensitive fields. You never get fields that only hosts see.
Who is left out
Section titled “Who is left out”Some people are not in data. They are still in count.
- People who set their profile to private.
- People who turned off Show me in attendee lists. See Profile privacy.
- Guests.
- Family profiles.
Errors
Section titled “Errors”| Status | Code | Meaning |
|---|---|---|
| 401 | invalid_token | The token is bad. |
| 403 | insufficient_scope | The token has no people scope. |
| 403 | not_registered | The member has no confirmed signup for this date. |
| 404 | event_not_found | The event does not exist, or the member cannot open it. |
| 404 | event_is_series | You sent the id of a recurring series. Send the id of one date. |
| 429 | rate_limited | Too many requests. Wait the seconds in the Retry-After header. |