Introduction
Welcome to the Talkpush API! Talkpush’s API allows you to instantly plug your candidate source to our platform so you can enjoy the benefits of Talkpush immediately with your existing setup!
Candidates
Search candidate
Example Request:
$ curl -X GET \
'https://my.talkpush.com/api/talkpush_services/campaign_invitations?api_key=abcde12345&api_secret=abcde12345&page=1&filters[query]=test@talkpush.com' \
-H 'Cache-Control: no-cache' \
-H 'Content-Type: application/json'
require 'uri'
require 'net/http'
url = URI("https://my.talkpush.com/api/talkpush_services/campaign_invitations?api_key=abcde12345&api_secret=abcde12345&page=1&filters[query]=test@talkpush.com")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Content-Type"] = 'application/json'
request["Cache-Control"] = 'no-cache'
response = http.request(request)
puts response.read_body
Make sure to replace
XXXXXX
with your API key
This api endpoint can be seen as a search engine API where you can type any query that you want. This will search through all documents
Request
GET https://my.talkpush.com/api/talkpush_services/campaign_invitations?api_key=XXXXXXXXX&filter%5Bquery%5D=594
URL Parameters
Parameter | Required | Value | Description |
---|---|---|---|
id | Yes | 1 | Candidate id that you want to move |
filter[query] | Yes | any kind of keywords | search keywords |
Credential Data Parameters
Parameter | Required | Value | Description |
---|---|---|---|
api_key | Yes | Your api key | API key of your account. |
List all candidates
Example Request:
$ curl -X GET \
'https://my.talkpush.com/api/talkpush_services/campaign_invitations?api_key=abcde12345&api_secret=abcde12345&page=1' \
-H 'Cache-Control: no-cache' \
-H 'Content-Type: application/json'
require 'uri'
require 'net/http'
url = URI("https://my.talkpush.com/api/talkpush_services/campaign_invitations?api_key=abcde12345&api_secret=abcde12345&page=1")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Content-Type"] = 'application/json'
request["Cache-Control"] = 'no-cache'
response = http.request(request)
puts response.read_body
Make sure to replace
abcde12345
with your API key and API secret.Example Response:
{
"total": 840,
"current_page": 1,
"pages": 70,
"candidates": [
{
"state": "hired",
"campaign_id": 12,
"id": 840,
"first_name": "Jewel",
"last_name": "Barton",
"campaign_title": "Dynamic Retail Coordinator",
"email": "waino_schultz@stoltenbergmills.com",
"user_phone_number": "3448460273",
"school_name": null,
"gender": null,
"employment": [
{
"company": "Sanin restaurant",
"organisation_name": "Sanin restaurant",
"description": "Département de communication Travail sur la stratgeie e-marketing Retranscription écrite Français/Anglais.",
"start_date": "2017-01",
"end_date": "notApplicable"
},
{
"description": "Département Marketing PowerPoint présentation. Gestion du portefeuille client",
"start_date": "2015-08",
"end_date": "2015-08"
},
{
"description": "Département d'acuille * confirmation des réservation avec les clients.",
"start_date": "2014-07",
"end_date": "2014-07"
},
{
"description": "Travail en groupe.",
"start_date": "2013",
"end_date": "2013"
}
],
"others": {}
},
{
"state": "hired",
"campaign_id": 12,
"id": 837,
"first_name": "Josue",
"last_name": "Howe",
"campaign_title": "Dynamic Retail Coordinator",
"email": "brady@feest.biz",
"user_phone_number": "2952783642",
"school_name": null,
"gender": null,
"employment": [],
"others": {}
},
{...},
{...},
]
}
Returns a list of candidates.
Request
GET https://my.talkpush.com/api/talkpush_services/campaign_invitations?api_key=<api_key>&api_secret=<api_secret>&page=<page>
URL Parameters
Parameter | Required | Value | Description |
---|---|---|---|
api_key | Yes | Your api key | API key of your account. |
api_secret | Yes | Your api secret | API secret of your account. |
page | No | 1 | Page number of candidate list to return. |
List all candidates from a campaign
Example Request:
$ curl -g -X GET \
'https://my.talkpush.com/api/talkpush_services/campaign_invitations?api_key=abcde12345&api_secret=abcde12345&page=1&filter[campaign_id]=1234' \
-H 'Cache-Control: no-cache' \
-H 'Content-Type: application/json'
require 'uri'
require 'net/http'
url = URI("https://my.talkpush.com/api/talkpush_services/campaign_invitations?api_key=abcde12345&api_secret=abcde12345&page=1&filter[campaign_id]=1234")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Content-Type"] = 'application/json'
request["Cache-Control"] = 'no-cache'
response = http.request(request)
puts response.read_body
Make sure to replace
abcde12345
with your API key and API secret.Example Response:
{
"total": 1,
"current_page": 1,
"pages": 1,
"candidates": [
{
"state": "shortlisted",
"campaign_id": 1234,
"id": 13654,
"first_name": "John",
"last_name": "Doe",
"campaign_title": "Campaign Title Demo",
"email": "johndoe@example.com",
"user_phone_number": "54268012",
"school_name": null,
"gender": null,
"employment": [],
"others": {}
}
]
}
Returns a list of candidates that belongs to a campaign.
Request
GET https://my.talkpush.com/api/talkpush_services/campaign_invitations?api_key=<api_key>&api_secret=<api_secret>&page=<page>&filter[campaign_id]=<filter[campaign_id]>
URL Parameters
Parameter | Required | Value | Description |
---|---|---|---|
api_key | Yes | Your api key | API key of your account. |
api_secret | Yes | Your api secret | API secret of your account. |
page | No | 1 | Page number of candidate list to return. |
filter[campaign_id] | Yes | 1234 | Campaign id of the campaign. |
List all candidates from multiple campaigns
Example Request:
$ curl -g -X GET \
'https://my.talkpush.com/api/talkpush_services/campaign_invitations?api_key=abcde12345&api_secret=abcde12345&page=1&filter[campaign_id][]=1&filter[campaign_id][]=2&filter[campaign_id][]=3' \
-H 'Cache-Control: no-cache' \
-H 'Content-Type: application/json'
require 'uri'
require 'net/http'
url = URI("https://my.talkpush.com/api/talkpush_services/campaign_invitations?api_key=abcde12345&api_secret=abcde12345&page=1&filter[campaign_id][]=1&filter[campaign_id][]=2&filter[campaign_id][]=3")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Content-Type"] = 'application/json'
request["Cache-Control"] = 'no-cache'
response = http.request(request)
puts response.read_body
Make sure to replace
abcde12345
with your API key and API secret.Example Response:
{
"total": 1,
"current_page": 1,
"pages": 1,
"candidates": [
{
"state": "hired",
"campaign_id": 1,
"id": 837,
"first_name": "Josue",
"last_name": "Howe",
"campaign_title": "Dynamic Retail Coordinator",
"email": "brady@feest.biz",
"user_phone_number": "2952783642",
"school_name": null,
"gender": null,
"employment": [],
"others": {}
},
{
"state": "hired",
"campaign_id": 2,
"id": 838,
"first_name": "Frances",
"last_name": "Hudson",
"campaign_title": "Dynamic Retail Coordinator",
"email": "chauncey_greenholt@runtelord.co",
"user_phone_number": "4750743129",
"school_name": null,
"gender": null,
"employment": [],
"others": {}
},
{
"state": "hired",
"campaign_id": 3,
"id": 834,
"first_name": "Mya",
"last_name": "Stamm",
"campaign_title": "Dynamic Retail Coordinator",
"email": "zula@ledner.org",
"user_phone_number": "7889053376",
"school_name": null,
"gender": null,
"employment": [],
"others": {}
},
]
}
Returns a list of candidates that belongs to multiple campaigns.
Request
GET https://my.talkpush.com/api/talkpush_services/campaign_invitations?api_key=<api_key>&api_secret=<api_secret>&page=<page>&filter[campaign_id][]=<filter[campaign_id][]>&filter[campaign_id][]=<filter[campaign_id][]>&filter[campaign_id][]=<filter[campaign_id][]>
URL Parameters
Parameter | Required | Value | Description |
---|---|---|---|
api_key | Yes | Your api key | API key of your account. |
api_secret | Yes | Your api secret | API secret of your account. |
page | No | 1 | Page number of candidate list to return. |
filter[campaign_id][] | Yes | 1 | Campaign id of the campaign. |
filter[campaign_id][] | Yes | 2 | Campaign id of the campaign. |
filter[campaign_id][] | Yes | 3 | Campaign id of the campaign. |
List all candidates with optional parameters
Example Request:
$ curl -g -X GET \
'https://my.talkpush.com/api/talkpush_services/campaign_invitations?api_key=abcde12345&api_secret=abcde12345&filter[campaign_id]=1&page=1&filter[status_selected]=completed&filter[creation_start_date]=01-01-2018&filter[creation_end_date]=01-01-2018&filter[source_selected]=Inbound&filter[location_selected]=Philippines&filter[location_radius_selected]=10&filter[label_selected]=Sample%20Label&filter[completion_method_selected]=Phone&filter[resume_selected]=attached&filter[scheduled_at_start_date]=01-01-2018&filter[scheduled_at_end_date]=01-01-2018&filter[sort_by_selected]=name' \
-H 'Cache-Control: no-cache' \
-H 'Content-Type: application/json'
require 'uri'
require 'net/http'
url = URI("https://my.talkpush.com/api/talkpush_services/campaign_invitations?api_key=abcde12345&api_secret=abcde12345&filter[campaign_id]=1&page=1&filter[status_selected]=completed&filter[creation_start_date]=01-01-2018&filter[creation_end_date]=01-01-2018&filter[source_selected]=Inbound&filter[location_selected]=Philippines&filter[location_radius_selected]=10&filter[label_selected]=Sample%20Label&filter[completion_method_selected]=Phone&filter[resume_selected]=attached&filter[scheduled_at_start_date]=01-01-2018&filter[scheduled_at_end_date]=01-01-2018&filter[sort_by_selected]=name")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Content-Type"] = 'application/json'
request["Cache-Control"] = 'no-cache'
response = http.request(request)
puts response.read_body
Make sure to replace
abcde12345
with your API key and API secret.Example Response:
{
"total": 840,
"current_page": 1,
"pages": 70,
"candidates": [
{
"state": "hired",
"campaign_id": 12,
"id": 840,
"first_name": "Jewel",
"last_name": "Barton",
"campaign_title": "Dynamic Retail Coordinator",
"email": "waino_schultz@stoltenbergmills.com",
"user_phone_number": "3448460273",
"school_name": null,
"gender": null,
"employment": [
{
"company": "Sanin restaurant",
"organisation_name": "Sanin restaurant",
"description": "Département de communication Travail sur la stratgeie e-marketing Retranscription écrite Français/Anglais.",
"start_date": "2017-01",
"end_date": "notApplicable"
},
{
"description": "Département Marketing PowerPoint présentation. Gestion du portefeuille client",
"start_date": "2015-08",
"end_date": "2015-08"
},
{
"description": "Département d'acuille * confirmation des réservation avec les clients.",
"start_date": "2014-07",
"end_date": "2014-07"
},
{
"description": "Travail en groupe.",
"start_date": "2013",
"end_date": "2013"
}
],
"others": {}
},
{
"state": "hired",
"campaign_id": 12,
"id": 837,
"first_name": "Josue",
"last_name": "Howe",
"campaign_title": "Dynamic Retail Coordinator",
"email": "brady@feest.biz",
"user_phone_number": "2952783642",
"school_name": null,
"gender": null,
"employment": [],
"others": {}
},
{...},
{...},
]
}
Returns a list of candidates that satisfies the parameters specified.
Request
GET https://my.talkpush.com/api/talkpush_services/campaign_invitations?api_key=<api_key>&api_secret=<api_secret>&filter[campaign_id]=<filter[campaign_id]>&page=<page>&filter[status_selected]=<filter[status_selected]>&filter[creation_start_date]=<filter[creation_start_date]>&filter[creation_end_date]=<filter[creation_end_date]>&filter[source_selected]=<filter[source_selected]>&filter[location_selected]=<filter[location_selected]>&filter[location_radius_selected]=<filter[location_radius_selected]>&filter[label_selected]=<filter[label_selected]>&filter[completion_method_selected]=<filter[completion_method_selected]>&filter[resume_selected]=<filter[resume_selected]>&filter[scheduled_at_start_date]=<filter[scheduled_at_start_date]>&filter[scheduled_at_end_date]=<filter[scheduled_at_end_date]>&filter[sort_by_selected]=<filter[sort_by_selected]>
URL Parameters
Parameter | Required | Value | Description |
---|---|---|---|
api_key | Yes | Your api key | API key of your account. |
api_secret | Yes | Your api secret | API secret of your account. |
page | No | 1 | Page number of candidate list to return. |
filter[campaign_id][] | No | 1 | Campaign id of the campaign. |
filter[status_selected] | No | [pending, completed, shortlisted, on_hold, rejected, hired, no_response] | Status of candidates. |
filter[creation_start_date] | No | 01-01-2018 (Date format: MM-DD-YYYY) | Creation start date of candidates. |
filter[creation_end_date] | No | 01-01-2018 (Date format: MM-DD-YYYY) | Creation end date of candidates. |
filter[source_selected] | No | Inbound | Source of candidates |
filter[location_selected] | No | Philippines | Location of candidates. |
filter[location_radius_selected] | No | 10 | Radius of candidates. |
filter[label_selected] | No | Name of label you created | Labels created for candidates. |
filter[completion_method_selected] | No | [Phone, Messenger] | Completion method of campaign invitation. |
filter[resume_selected] | No | [attached, not_attached] | If attached is set, it will look for candidates with resume. |
filter[scheduled_at_start_date] | No | 01-01-2018 (Date format: MM-DD-YYYY) | Scheduled start date of candidates. |
filter[scheduled_at_end_date] | No | 01-01-2018 (Date format: MM-DD-YYYY) | Scheduled end date of candidates. |
filter[sort_by_selected] | No | [name, source, location, created_at, completion_date] | Sorting of candidate results. |
Update candidate
Example Request:
$ curl -X PATCH \
'https://my.talkpush.com/api/talkpush_services/campaign_invitations/1?abcde12345=key&api_secret=abcde12345' \
-H 'Cache-Control: no-cache' \
-H 'Content-Type: application/json' \
-d '{
"candidate" : {
"first_name": "John",
"last_name": "Lucky",
"email": "john.lucky@example.com",
"school_name": "School of Rock",
"gender": "M",
"user_phone_number": "123456789",
"others": {
"realms_online" : "yes"
}
}
}'
require 'uri'
require 'net/http'
url = URI("https://my.talkpush.com/api/talkpush_services/campaign_invitations/1?abcde12345=key&api_secret=abcde12345")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request["Cache-Control"] = 'no-cache'
request.body = '{
"candidate" : {
"first_name": "John",
"last_name": "Luck",
"email": "john.lucky@example.com",
"school_name": "School of Rock",
"gender": "M",
"user_phone_number": "123456789",
"others": {
"realms_online": "yes"
}
}
}'
response = http.request(request)
puts response.read_body
Make sure to replace
abcde12345
with your API key and API secret.
Updates the candidate with the supplied parameters. This will return HTTP 200
response if update is a success.
Request
PATCH https://my.talkpush.com/api/talkpush_services/campaign_invitations/<id>?api_key=<api_key>&api_secret=<api_secret>
URL Parameters
Parameter | Required | Value | Description |
---|---|---|---|
api_key | Yes | Your api key | API key of your account. |
api_secret | Yes | Your api secret | API secret of your account. |
id | Yes | 1 | Candidate id of candidate. |
Data Parameters
Parameter | Required | Value | Description |
---|---|---|---|
first_name | Yes | John | First name of candidate. |
last_name | Yes | Lucky | Last name of candidate. |
Yes | john.lucky@example.com | Email of candidate. | |
school_name | Yes | School of Rock | School of candidate. |
gender | Yes | [M, F] | Gender of candidate. |
user_phone_number | Yes | 123456789 | Phone number of candidate. |
others | No | {"realms_online" : "yes"} (JSON Format) | Other information of candidate. |
Create candidate
Example Request:
$ curl -X POST \
'https://my.talkpush.com/api/talkpush_services/campaigns/1/campaign_invitations' \
-H 'Cache-Control: no-cache' \
-H 'Content-Type: application/json' \
-d '{
"api_key": "abcde12345",
"api_secret": "abcde12345",
"campaign_invitation": {
"first_name": "John",
"last_name": "Peters",
"email": "john.peters@example.com",
"user_phone_number": "123456789"
}
}'
require 'uri'
require 'net/http'
url = URI("https://my.talkpush.com/api/talkpush_services/campaigns/1/campaign_invitations")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request["Cache-Control"] = 'no-cache'
request.body = '{
"api_key": "abcde12345",
"api_secret": "abcde12345",
"campaign_invitation": {
"first_name": "John",
"last_name": "Peters",
"email": "john.peters@example.com",
"user_phone_number": "123456789"
}
}'
response = http.request(request)
puts response.read_body
Make sure to replace
abcde12345
with your API key and API secret.Example Response:
{
"url": "https://my.talkpush.com/guests/campaign_invitations/866/outbound_call?company_id=3&outbound_token=28dc9476602c97d48a712db94367c084372d4b37d13fccea07e6b5eaacd1f24d&source=MICROSITE",
"pin": "953158"
}
Updates the candidate with the supplied parameters. This will return HTTP 200
response if update is a success.
Request
POST https://my.talkpush.com/api/talkpush_services/campaigns/<id>/campaign_invitations
URL Parameters
Parameter | Required | Value | Description |
---|---|---|---|
id | Yes | 1 | Campaign id of the campaign. |
Credential Data Parameters
Parameter | Required | Value | Description |
---|---|---|---|
api_key | Yes | Your api key | API key of your account. |
api_secret | Yes | Your api secret | API secret of your account. |
Candidate Data Parameters
Parameter | Required | Value | Description |
---|---|---|---|
campaign_invitation[first_name] | Yes | John | First name of candidate. |
campaign_invitation[last_name] | Yes | Peters | Last name of candidate. |
campaign_invitation[email] | Yes | john.peters@example.com | Email of candidate. |
campaign_invitation[user_phone_number] | Yes | 123456789 | Phone number of candidate. |
campaign_invitation[temporary_cv] | No | Raw file | Raw file representing candidate resume |
campaign_invitation[source] | No | Microsite name | Name of the microsite sending information |
Referee Fixed Data Parameters
Parameter | Required | Value | Description |
---|---|---|---|
campaign_invitation[others][referee_first_name] | No | Lisa | First name of referee |
campaign_invitation[others][referee_last_name] | No | Summers | Last name of referee |
Referee Extra Data Parameters
Parameter | Required | Value | Description |
---|---|---|---|
campaign_invitation[others][referee_id] | No | 1 | (Employee) ID of referee |
campaign_invitation[others][referee_email] | No | email@example.com | Email of referee |
campaign_invitation[others][referee_mobile] | No | 123456789 | Phone Number of referee |
campaign_invitation[others][referee_account] | No | Account name | Account of referee |
campaign_invitation[others][position] | No | Manager | Position of referee |
campaign_invitation[others][bpo_experience] | No | 10 years | (BPO) Working experience of Referee |
campaign_invitation[others][column_title] | No | Any text | Any extra data you wish to store |
Update candidate status
Example Request:
$ curl -X PUT \
'https://my.talkpush.com/api/talkpush_services/campaign_invitations/1/hire?api_key=XXXXX' \
-H 'Cache-Control: no-cache' \
-H 'Content-Type: application/json' \
require 'uri'
require 'net/http'
url = URI("https://my.talkpush.com/api/talkpush_services/campaigns/1/campaign_invitations/1/hire?api_key=XXXXXX")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request["Cache-Control"] = 'no-cache'
response = http.request(request)
puts response.read_body
Make sure to replace
XXXXXX
with your API key
Perform the action on the provided candidate, following actions are currently supported:
- shortlist
- reject
- on_hold
- hire
Request
POST https://my.talkpush.com/api/talkpush_services/campaign_invitations/<status>
URL Parameters
Parameter | Required | Value | Description |
---|---|---|---|
id | Yes | 1 | Candidate id that you want to move |
status | Yes | shortlist,reject,hire,on_hold | Folder onto which you want to move candidate |
Credential Data Parameters
Parameter | Required | Value | Description |
---|---|---|---|
api_key | Yes | Your api key | API key of your account. |
Realms Online
List all candidates with Realms Online
Example Request:
$ curl -g -X GET \
'https://my.talkpush.com/api/talkpush_services/campaign_invitations?api_key=abcde12345&api_secret=abcde12345&page=1&filter[realms_online]=1' \
-H 'Cache-Control: no-cache' \
-H 'Content-Type: application/json'
require 'uri'
require 'net/http'
url = URI("https://my.talkpush.com/api/talkpush_services/campaign_invitations?api_key=abcde12345&api_secret=abcde12345&page=1&filter[realms_online]=1")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Content-Type"] = 'application/json'
request["Cache-Control"] = 'no-cache'
response = http.request(request)
puts response.read_body
Make sure to replace
abcde12345
with your API key and API secret.Example Response:
{
"total": 1,
"current_page": 1,
"pages": 1,
"candidates": [
{
"state": "shortlisted",
"campaign_id": 2152,
"id": 13654,
"first_name": "John",
"last_name": "Doe",
"campaign_title": "Campaign Title Demo",
"email": "johndoe@testemail.com",
"user_phone_number": "54268012",
"school_name": null,
"gender": null,
"employment": [],
"others": {
"realms_online": "yes"
}
}
]
}
Returns a list of candidates with realms_online
data.
Request
GET https://my.talkpush.com/api/talkpush_services/campaign_invitations?api_key=<api_key>&api_secret=<api_secret>&page=<page>&filter[realms_online]=<filter[realms_online]>
URL Parameters
Parameter | Required | Value | Description |
---|---|---|---|
api_key | Yes | Your api key | API key of your account. |
api_secret | Yes | Your api secret | API secret of your account. |
page | No | 1 | Page number of candidate list to return. |
filter[realms_online] | Yes | 1 | If set to 1, the result will also include candidates with Realms Online data. |
List all candidates without Realms Online
Example Request:
$ curl -g https://my.talkpush.com/api/talkpush_services/campaign_invitations?api_key=abcde12345&api_secret=abcde12345&page=1&filter[realms_online]=0
$ curl -g -X GET \
'https://my.talkpush.com/api/talkpush_services/campaign_invitations?api_key=abcde12345&api_secret=abcde12345&page=1&filter[realms_online]=0' \
-H 'Cache-Control: no-cache' \
-H 'Content-Type: application/json'
require 'uri'
require 'net/http'
url = URI("https://my.talkpush.com/api/talkpush_services/campaign_invitations?api_key=abcde12345&api_secret=abcde12345&page=1&filter[realms_online]=0")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Content-Type"] = 'application/json'
request["Cache-Control"] = 'no-cache'
response = http.request(request)
puts response.read_body
Make sure to replace
abcde12345
with your API key and API secret.Example Response:
{
"total": 1,
"current_page": 1,
"pages": 1,
"candidates": [
{
"state": "hired",
"campaign_id": 12,
"id": 838,
"first_name": "Frances",
"last_name": "Hudson",
"campaign_title": "Dynamic Retail Coordinator",
"email": "chauncey_greenholt@runtelord.co",
"user_phone_number": "4750743129",
"school_name": null,
"gender": null,
"employment": [],
"others": {}
}
]
}
Returns a list of candidates with realms_online
data.
Request
GET https://my.talkpush.com/api/talkpush_services/campaign_invitations?api_key=<api_key>&api_secret=<api_secret>&page=<page>&filter[realms_online]=<filter[realms_online]>
URL Parameters
Parameter | Required | Value | Description |
---|---|---|---|
api_key | Yes | Your api key | API key of your account. |
api_secret | Yes | Your api secret | API secret of your account. |
page | No | 1 | Page number of candidate list to return. |
filter[realms_online] | Yes | 0 | If set to 0, the result will include candidates without Realms Online data. |