Search Members

GET

members

cURL

curl --request GET \
  --url https://api.onsi.com/v1/members \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api.onsi.com/v1/members"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.onsi.com/v1/members', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.onsi.com/v1/members",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.onsi.com/v1/members"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.onsi.com/v1/members")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.onsi.com/v1/members")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "members": [
    {
      "email": "jsmith@example.com",
      "memberId": "mem_q5sdae3se6eg9m9dcvug",
      "firstName": "John",
      "lastName": "Smith",
      "phone": "+447123456789",
      "tier": "Gold",
      "workerId": "ID_123",
      "accountDetails": {
        "accountHolder": "John Smith",
        "sortCode": "123456",
        "accountNumber": "12345678"
      },
      "enablePayroll": true,
      "dob": "1990-01-01"
    }
  ],
  "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

Query Parameters

memberIds

string[]

Filter by internal Onsi member IDs

The unique identifier for a Member, prefixed with mem_

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

Unique ID provided by API consumer, must be unique across all members (active, invited and inactive)

skip

number

default:0

required

take

number

default:50

required

Response

200 - application/json

200

members

Member · object[]

required

Show child attributes

total

number

required

Example:

1

skip

number

required

Example:

0

take

number

required

Example:

50

Get Job

⌘I

cURL

curl --request GET \
  --url https://api.onsi.com/v1/members \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api.onsi.com/v1/members"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.onsi.com/v1/members', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.onsi.com/v1/members",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.onsi.com/v1/members"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.onsi.com/v1/members")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.onsi.com/v1/members")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "members": [
    {
      "email": "jsmith@example.com",
      "memberId": "mem_q5sdae3se6eg9m9dcvug",
      "firstName": "John",
      "lastName": "Smith",
      "phone": "+447123456789",
      "tier": "Gold",
      "workerId": "ID_123",
      "accountDetails": {
        "accountHolder": "John Smith",
        "sortCode": "123456",
        "accountNumber": "12345678"
      },
      "enablePayroll": true,
      "dob": "1990-01-01"
    }
  ],
  "total": 1,
  "skip": 0,
  "take": 50
}

Members

Tiering

On Demand Pay

Member Statuses

Member Identifiers

Authorizations

Query Parameters

Response

​Member Statuses

​Member Identifiers

Authorizations

Query Parameters

Response

Member Statuses

Member Identifiers