GET
/
v1
/
members

This API can be used to search for members on your platform.

​
Member Statuses

  • active: Member has accepted the invitation and is active on the platform.
  • invited: Member has been invited but has not yet accepted the invitation.
  • inactive: Member has been removed (or offboarded) from the platform.

​
Member Identifiers

  • memberId: The Onsi-issued unique identifier for the member.
  • workerId: An external identifier for the member, such as an employee ID, this is typically used to identify the member in your system (this is optional).

Authorizations

X-API-KEY
string
headerrequired

Headers

x-idempotency-key
string

Unique key to ensure idempotency of the request

Query Parameters

memberIds
string[]

Filter by internal Onsi member IDs

statuses
enum<string>[]

Filter by member status

Available options:
active,
invited,
inactive
emails
string[]

Filter by member's email

workerIds
string[]

Filter by your worker IDs

skip
string
default: 0
take
string
default: 50

Response

200 - application/json
members
object[]
required
total
number
required
skip
number
required
take
number
required
Upload Full Member List CSVGet Job