Skip to main content
POST
Search the members of an organization

Authorizations

Authorization
string
header
required

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

Body

application/json

Optional role/active filters and pagination for the members search.

role
enum<string>
required

Role of the organization member

Available options:
Admin,
Member
Example:

"Admin"

isActive
boolean
required

Active status of the organization member

Example:

true

page
number
required

Page of the organization members list

Example:

1

offset
number
required

Page offset of the organization members list

Example:

20

environment
enum<string>
required

Environment to get stripe account id from (live or sandbox)

Available options:
live,
sandbox
Example:

"sandbox"

Response

Paginated organization members with the total active-admin count.

totalResults
number
required

Total number of results found

Example:

137

members
object[]
required

List of organization members with profile information

page
number
required

Page of the notifications list

Example:

1

offset
number
required

Page offset of the notifications list

Example:

20

totalActiveAdmins
number
required

Total number of ACTIVE admins in the organization (not just on this page). Used by the webapp to guard "demote / deactivate / remove last admin" actions when the relevant admin sits on a different page than the viewer.

Example:

2