List companies
curl --request GET \
--url https://app.sideshift.app/api/oauth/v1/companies \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.sideshift.app/api/oauth/v1/companies"
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/companies', 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/companies",
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/companies"
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/companies")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.sideshift.app/api/oauth/v1/companies")
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": [
{
"id": "<string>",
"name": "<string>",
"profileImageUrl": "<string>",
"isPro": true,
"plan": "<string>",
"isAgency": true,
"stripeCustomerId": "<string>",
"expirationPro": "<string>",
"parentCompanyId": "<string>",
"phone": "<string>",
"userId": "<string>",
"email": "<string>",
"website": "<string>",
"appstoreUrl": "<string>",
"recruitmentEnabled": "<unknown>",
"discover": true,
"isInheritedAccess": true,
"isAgencyChild": true,
"separateAgencySubs": true,
"customContract": "<unknown>",
"highFrequencyScrapeEnabled": true,
"createdAtMs": 123,
"turnOnWithdraw": true,
"restrictWithdrawals": true,
"withdrawalApprovalNotes": "<string>",
"withdrawalApprovalCountry": "<string>",
"createdViaEmbed": true,
"embedIntegratorId": "<string>",
"isArchivedInAgencyDashboard": true,
"maxActiveClients": 123,
"accountSuspended": true,
"effectiveAccountSuspension": "<unknown>",
"campaignWalletActivationLock": "<unknown>"
}
]
}{
"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_..."
}
}List companies
list the token tenant’s companies with Pro/plan status. Requires the settings:read scope.
GET
/
companies
List companies
curl --request GET \
--url https://app.sideshift.app/api/oauth/v1/companies \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.sideshift.app/api/oauth/v1/companies"
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/companies', 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/companies",
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/companies"
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/companies")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.sideshift.app/api/oauth/v1/companies")
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": [
{
"id": "<string>",
"name": "<string>",
"profileImageUrl": "<string>",
"isPro": true,
"plan": "<string>",
"isAgency": true,
"stripeCustomerId": "<string>",
"expirationPro": "<string>",
"parentCompanyId": "<string>",
"phone": "<string>",
"userId": "<string>",
"email": "<string>",
"website": "<string>",
"appstoreUrl": "<string>",
"recruitmentEnabled": "<unknown>",
"discover": true,
"isInheritedAccess": true,
"isAgencyChild": true,
"separateAgencySubs": true,
"customContract": "<unknown>",
"highFrequencyScrapeEnabled": true,
"createdAtMs": 123,
"turnOnWithdraw": true,
"restrictWithdrawals": true,
"withdrawalApprovalNotes": "<string>",
"withdrawalApprovalCountry": "<string>",
"createdViaEmbed": true,
"embedIntegratorId": "<string>",
"isArchivedInAgencyDashboard": true,
"maxActiveClients": 123,
"accountSuspended": true,
"effectiveAccountSuspension": "<unknown>",
"campaignWalletActivationLock": "<unknown>"
}
]
}{
"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.
Response
The token tenant's company (and, for an agency parent, its direct subaccounts) with Pro/plan status and agency flags.
Envelope for the token tenant's company list (own company plus, for an agency parent, its direct subaccounts).
Show child attributes
Show child attributes
⌘I