GET
/
v1
/
members
curl --request GET \
  --url https://api.onsi.com/v1/members \
  --header 'X-API-KEY: <api-key>'
{
  "members": [
    {
      "email": "jsmith@example.com",
      "memberId": "mem_q5sdae3se6eg9m9dcvug",
      "firstName": "John",
      "lastName": "Smith",
      "phone": "+447123456789",
      "tier": "Gold",
      "workerId": "ID_123",
      "status": "active",
      "accountDetails": {
        "accountHolder": "John Smith",
        "sortCode": "123456",
        "accountNumber": "12345678"
      },
      "enablePayroll": true
    }
  ],
  "total": 1,
  "skip": 0,
  "take": 50
}

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 from the platform, or they have requested their Onsi account to be deleted.

​
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
header
required

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
200
​
members
object[]
required
​
total
number
required
​
skip
number
required
​
take
number
required
Upload Full Member List CSVGet Job