Skip to content

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.

GET /events/{id}/people

Pass the id of one date. The member must be going to that date with a confirmed signup. The member is not in the list.

QueryTypeMeaning
pagenumberThe page to read. Starts at 1. Default 1.
pageSizenumberPeople per page. From 1 to 100. Default 20.

The reply has these fields.

FieldMeaning
shownfalse when the club hides the faces of attendees. Then data is empty.
countHow many people are going. The event page shows the same number.
dataThe list of people.
paginationThe 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, avatarUrl is null for everyone.
  • When the club shows a count only, shown is false.
  • When fewer people go than the Show after number of the event, shown is false. The club sets this number under Minimum to Display. count still has the real number.
FieldMeaning
memberIdThe member id in this club.
nameThe name, by language code. nameText is one text.
handleThe handle of the profile. Can be null.
avatarUrlThe photo. Can be null.
bioThe bio, by language code. bioText is one text.
socialLinksThe social links. The club can hide some platforms.
rolesThe roles of the member in the club.
propertiesAnswers 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.

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.
StatusCodeMeaning
401invalid_tokenThe token is bad.
403insufficient_scopeThe token has no people scope.
403not_registeredThe member has no confirmed signup for this date.
404event_not_foundThe event does not exist, or the member cannot open it.
404event_is_seriesYou sent the id of a recurring series. Send the id of one date.
429rate_limitedToo many requests. Wait the seconds in the Retry-After header.