Help Center

Members and check-ins

See API introduction for authentication, request conventions, pagination, rate limits, and errors.

Members in Activity Messenger are people who have a membership in your organization. A member is identified by their unique ID in the database but may have a different client-facing membership_no as presented on their membership card barcode. You may always use the membership_no to lookup - those are guaranteed to be unique.

A member has active_at and expired_at dates. The membership is active within that window, inclusively. When those dates are null, the membership is always active. A membership expires at the end of the expired_at day.

A membership also has a status. When null the member is active. When pending or suspended, the membership should be blocked.

A member object contains these attributes.

{
  "id": 1234,
  "membership_no": 1234,
  "name": "Harry Potter",
  "first_name": "Harry",
  "last_name": "Potter",
  "email": "harry@hogwartsrec.com",
  "mobile": "555-123-1234",
  "expired_at": "2023-05-19",
  "active_at": "2022-05-19",
  "status": null,
  "image_url": null}

GET /api/v1/organization/{organization}/members

Retrieve members. See Pagination section for instructions on how to fetch all memberships. For example, to retrieve the maximum pass query string ?per_page=250.

GET /api/v1/organization/{organization}/members/{member}

Retrieve a member by membership_no or by database ID.

POST /api/v1/organization/{organization}/members/{member}/checkin

Call when the membership card is scanned. In the URL, {member} is the membership_no or the database ID. In the payload, attribute location_id is for future use and should be set to null. Attribute action should either be pass or fail. Set to fail when outside of the active_at and expired_at window. Set to fail when status is not null. Upon successful call, simply returns HTTP code 200 with the member in the payload.

{
  "location_id": null,
  "action": "pass"}