Search

Returns all people matching the requested query. Does not include Admins. Requires read permissions.

GET /people

cURL

cURL

curl --request GET \
  --url https://membership.sjaa.net/api/people \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "active": "<string>",
  "discord_id": "<string>",
  "has_discord": true,
  "has_telescopius": true
}
'

200

[
  {
    "id": "<array>",
    "contacts": "<array>",
    "memberships": "<array>",
    "first_name": "<string>",
    "last_name": "<string>",
    "discord_id": "<string>"
  }
]

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

email · string

Filter by given email address.

first_name · string

Filter by given first name.

last_name · string

Filter by given last name.

active · Active · string Inactive · string

People with a current membership.

Allowed value: "yes"

discord_id · string

Filter by given Discord user ID.

has_discord · boolean

Filter by the presence of a Discord user ID.

has_telescopius · boolean

Filter by the presence of a Telescopius user ID.

Response

200

application/json

Array of people.

id · array

Internal database identifier. Use where :id is required.

contacts · array

List of contacts, including address, phone, and email.

memberships · array

List of memberships, which include start and end dates.

first_name · string

first name.

last_name · string

last name.

discord_id · string

Discord user ID.