List members

get

https://api.joyful.org/platforms/{platformId}/members

Returns a list of members. If there are no members, the list will be empty.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

platformId

string

required

Query Params

created_since

date-time

Filter members by the date they were created. The value should be an ISO 8601 formatted string: yyyy-MM-ddTHH:mm:ssZ

modified_since

date-time

Filter members by the date they were modified. The value should be an ISO 8601 formatted string: yyyy-MM-ddTHH:mm:ssZ

search_term

string

Filter members by matching first name, last name or email address.
The value should be a string and can either be a full or partial search term.
Partial searches should start from the beginning of the string,
for example Joh would return a member called John, but ohn would not.

groupId

uuid

Filter members by the group they are a member of.

groupApprovalStatus

string

enum

Filter members by their approval status for a given group they are a member of.

Allowed:

roleName

array of strings

Filter members by role, using the role name. To filter on multiple roles, pass in multiple query string values (e.g. ?roleName=role&roleName=role).

roleName

page

int32

per_page

int32

Responses

400

Invalid request

401

Unauthorized

403

Forbidden

404

Not Found

200OK