Get a recruit candidate
curl --request GET \
--url https://app.sideshift.app/api/oauth/v1/recruit/students/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.sideshift.app/api/oauth/v1/recruit/students/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.sideshift.app/api/oauth/v1/recruit/students/{id}', 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://app.sideshift.app/api/oauth/v1/recruit/students/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://app.sideshift.app/api/oauth/v1/recruit/students/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.sideshift.app/api/oauth/v1/recruit/students/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.sideshift.app/api/oauth/v1/recruit/students/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"userId": "<string>",
"name": "<string>",
"college": "<string>",
"major": "<string>",
"academicLevel": "<string>",
"hometown": "<string>",
"profileImageUrl": "<string>",
"oneLiner": "<string>",
"creatorVerified": true,
"superUser": true,
"instagram": "<string>",
"tiktok": "<string>",
"linkedin": "<string>",
"topPosts": [
"<unknown>"
],
"niches": [
"<string>"
],
"pastWork": [
"<unknown>"
],
"hasInstagram": true,
"hasTikTok": true,
"hasTopPosts": true,
"usBased": true,
"hasBeenPaid": true,
"experiences": [
"<unknown>"
],
"involvement": [
"<unknown>"
],
"lastActive": "<unknown>",
"hasThreePosts": true,
"xp": 123,
"country": "<string>",
"stripeCountry": "<string>",
"location": "<string>",
"state": "<string>",
"city": "<string>",
"region": "<string>",
"gender": "<string>",
"birthday": "<string>",
"birthdayTimestamp": 123,
"certifications": [
"<unknown>"
],
"achievementProgress": [
"<unknown>"
],
"creatorLeaderboard": "<unknown>",
"totalViews": 123,
"totalEarnings": 123,
"averageRating": 123,
"reviewCount": 123,
"graduationStatus": "<string>",
"graduationYear": 123,
"trainingProgressPercent": 123,
"trainingNodesCompleted": 123,
"activeCertificationTypes": [
"<string>"
],
"activeCertificationCount": 123,
"unlockedAchievementKeys": [
"<string>"
],
"unlockedAchievementCount": 123
}
}{
"error": {
"code": "unauthorized",
"message": "Missing bearer access token",
"requestId": "req_..."
}
}{
"error": {
"code": "insufficient_scope",
"message": "Requires scope 'campaigns:write'",
"requestId": "req_..."
}
}{
"error": {
"code": "not_found",
"message": "Resource not found",
"requestId": "req_..."
}
}{
"error": {
"code": "rate_limited",
"message": "Rate limit exceeded",
"requestId": "req_..."
}
}Get a recruit candidate
fetch one recruit candidate’s full enriched profile and top posts by id. Requires the recruit:read scope.
GET
/
recruit
/
students
/
{id}
Get a recruit candidate
curl --request GET \
--url https://app.sideshift.app/api/oauth/v1/recruit/students/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.sideshift.app/api/oauth/v1/recruit/students/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.sideshift.app/api/oauth/v1/recruit/students/{id}', 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://app.sideshift.app/api/oauth/v1/recruit/students/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://app.sideshift.app/api/oauth/v1/recruit/students/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.sideshift.app/api/oauth/v1/recruit/students/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.sideshift.app/api/oauth/v1/recruit/students/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"userId": "<string>",
"name": "<string>",
"college": "<string>",
"major": "<string>",
"academicLevel": "<string>",
"hometown": "<string>",
"profileImageUrl": "<string>",
"oneLiner": "<string>",
"creatorVerified": true,
"superUser": true,
"instagram": "<string>",
"tiktok": "<string>",
"linkedin": "<string>",
"topPosts": [
"<unknown>"
],
"niches": [
"<string>"
],
"pastWork": [
"<unknown>"
],
"hasInstagram": true,
"hasTikTok": true,
"hasTopPosts": true,
"usBased": true,
"hasBeenPaid": true,
"experiences": [
"<unknown>"
],
"involvement": [
"<unknown>"
],
"lastActive": "<unknown>",
"hasThreePosts": true,
"xp": 123,
"country": "<string>",
"stripeCountry": "<string>",
"location": "<string>",
"state": "<string>",
"city": "<string>",
"region": "<string>",
"gender": "<string>",
"birthday": "<string>",
"birthdayTimestamp": 123,
"certifications": [
"<unknown>"
],
"achievementProgress": [
"<unknown>"
],
"creatorLeaderboard": "<unknown>",
"totalViews": 123,
"totalEarnings": 123,
"averageRating": 123,
"reviewCount": 123,
"graduationStatus": "<string>",
"graduationYear": 123,
"trainingProgressPercent": 123,
"trainingNodesCompleted": 123,
"activeCertificationTypes": [
"<string>"
],
"activeCertificationCount": 123,
"unlockedAchievementKeys": [
"<string>"
],
"unlockedAchievementCount": 123
}
}{
"error": {
"code": "unauthorized",
"message": "Missing bearer access token",
"requestId": "req_..."
}
}{
"error": {
"code": "insufficient_scope",
"message": "Requires scope 'campaigns:write'",
"requestId": "req_..."
}
}{
"error": {
"code": "not_found",
"message": "Resource not found",
"requestId": "req_..."
}
}{
"error": {
"code": "rate_limited",
"message": "Rate limit exceeded",
"requestId": "req_..."
}
}Authorizations
OAuth 2.1 authorization code + PKCE (S256). Tokens are tenant-bound (company_id) and scoped. Discover endpoints via /.well-known/oauth-authorization-server.
Path Parameters
The id.
Response
One recruit candidate's full enriched profile (phone stripped).
An enriched recruit candidate. The phone field is redacted/stripped before leaving the server. Additional fields may be present.
Show child attributes
Show child attributes
⌘I