Create a company
curl --request POST \
--url https://app.sideshift.app/api/oauth/v1/companies/create \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"parentCompanyId": "<string>",
"privacyPolicyAccepted": true,
"termsOfServiceAccepted": true,
"phone": "<string>",
"website": "<string>",
"appstoreUrl": "<string>",
"category": "<string>",
"companyStage": "<string>",
"hireRange": "<string>",
"companyNiche": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>"
},
"instagram": "<string>",
"linkedin": "<string>",
"tiktok": "<string>",
"profileImageUrl": "<string>",
"createRequestId": "<string>"
}
'import requests
url = "https://app.sideshift.app/api/oauth/v1/companies/create"
payload = {
"name": "<string>",
"parentCompanyId": "<string>",
"privacyPolicyAccepted": True,
"termsOfServiceAccepted": True,
"phone": "<string>",
"website": "<string>",
"appstoreUrl": "<string>",
"category": "<string>",
"companyStage": "<string>",
"hireRange": "<string>",
"companyNiche": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>"
},
"instagram": "<string>",
"linkedin": "<string>",
"tiktok": "<string>",
"profileImageUrl": "<string>",
"createRequestId": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
parentCompanyId: '<string>',
privacyPolicyAccepted: true,
termsOfServiceAccepted: true,
phone: '<string>',
website: '<string>',
appstoreUrl: '<string>',
category: '<string>',
companyStage: '<string>',
hireRange: '<string>',
companyNiche: '<string>',
address: {
line1: '<string>',
line2: '<string>',
city: '<string>',
state: '<string>',
postal_code: '<string>',
country: '<string>'
},
instagram: '<string>',
linkedin: '<string>',
tiktok: '<string>',
profileImageUrl: '<string>',
createRequestId: '<string>'
})
};
fetch('https://app.sideshift.app/api/oauth/v1/companies/create', 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/create",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'parentCompanyId' => '<string>',
'privacyPolicyAccepted' => true,
'termsOfServiceAccepted' => true,
'phone' => '<string>',
'website' => '<string>',
'appstoreUrl' => '<string>',
'category' => '<string>',
'companyStage' => '<string>',
'hireRange' => '<string>',
'companyNiche' => '<string>',
'address' => [
'line1' => '<string>',
'line2' => '<string>',
'city' => '<string>',
'state' => '<string>',
'postal_code' => '<string>',
'country' => '<string>'
],
'instagram' => '<string>',
'linkedin' => '<string>',
'tiktok' => '<string>',
'profileImageUrl' => '<string>',
'createRequestId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.sideshift.app/api/oauth/v1/companies/create"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"parentCompanyId\": \"<string>\",\n \"privacyPolicyAccepted\": true,\n \"termsOfServiceAccepted\": true,\n \"phone\": \"<string>\",\n \"website\": \"<string>\",\n \"appstoreUrl\": \"<string>\",\n \"category\": \"<string>\",\n \"companyStage\": \"<string>\",\n \"hireRange\": \"<string>\",\n \"companyNiche\": \"<string>\",\n \"address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"instagram\": \"<string>\",\n \"linkedin\": \"<string>\",\n \"tiktok\": \"<string>\",\n \"profileImageUrl\": \"<string>\",\n \"createRequestId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.sideshift.app/api/oauth/v1/companies/create")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"parentCompanyId\": \"<string>\",\n \"privacyPolicyAccepted\": true,\n \"termsOfServiceAccepted\": true,\n \"phone\": \"<string>\",\n \"website\": \"<string>\",\n \"appstoreUrl\": \"<string>\",\n \"category\": \"<string>\",\n \"companyStage\": \"<string>\",\n \"hireRange\": \"<string>\",\n \"companyNiche\": \"<string>\",\n \"address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"instagram\": \"<string>\",\n \"linkedin\": \"<string>\",\n \"tiktok\": \"<string>\",\n \"profileImageUrl\": \"<string>\",\n \"createRequestId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.sideshift.app/api/oauth/v1/companies/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"parentCompanyId\": \"<string>\",\n \"privacyPolicyAccepted\": true,\n \"termsOfServiceAccepted\": true,\n \"phone\": \"<string>\",\n \"website\": \"<string>\",\n \"appstoreUrl\": \"<string>\",\n \"category\": \"<string>\",\n \"companyStage\": \"<string>\",\n \"hireRange\": \"<string>\",\n \"companyNiche\": \"<string>\",\n \"address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"instagram\": \"<string>\",\n \"linkedin\": \"<string>\",\n \"tiktok\": \"<string>\",\n \"profileImageUrl\": \"<string>\",\n \"createRequestId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"success": true,
"checkoutUrl": "<string>",
"companyId": "<string>",
"stripeCustomerId": "<string>",
"requiresPerClientCheckout": true,
"isFreeClient": true,
"idempotent": true,
"message": "<string>"
}
}{
"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_..."
}
}Create a company
create a company / agency sub-account, or start a Stripe checkout for an additional paid client. Requires the settings:write scope.
POST
/
companies
/
create
Create a company
curl --request POST \
--url https://app.sideshift.app/api/oauth/v1/companies/create \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"parentCompanyId": "<string>",
"privacyPolicyAccepted": true,
"termsOfServiceAccepted": true,
"phone": "<string>",
"website": "<string>",
"appstoreUrl": "<string>",
"category": "<string>",
"companyStage": "<string>",
"hireRange": "<string>",
"companyNiche": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>"
},
"instagram": "<string>",
"linkedin": "<string>",
"tiktok": "<string>",
"profileImageUrl": "<string>",
"createRequestId": "<string>"
}
'import requests
url = "https://app.sideshift.app/api/oauth/v1/companies/create"
payload = {
"name": "<string>",
"parentCompanyId": "<string>",
"privacyPolicyAccepted": True,
"termsOfServiceAccepted": True,
"phone": "<string>",
"website": "<string>",
"appstoreUrl": "<string>",
"category": "<string>",
"companyStage": "<string>",
"hireRange": "<string>",
"companyNiche": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>"
},
"instagram": "<string>",
"linkedin": "<string>",
"tiktok": "<string>",
"profileImageUrl": "<string>",
"createRequestId": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
parentCompanyId: '<string>',
privacyPolicyAccepted: true,
termsOfServiceAccepted: true,
phone: '<string>',
website: '<string>',
appstoreUrl: '<string>',
category: '<string>',
companyStage: '<string>',
hireRange: '<string>',
companyNiche: '<string>',
address: {
line1: '<string>',
line2: '<string>',
city: '<string>',
state: '<string>',
postal_code: '<string>',
country: '<string>'
},
instagram: '<string>',
linkedin: '<string>',
tiktok: '<string>',
profileImageUrl: '<string>',
createRequestId: '<string>'
})
};
fetch('https://app.sideshift.app/api/oauth/v1/companies/create', 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/create",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'parentCompanyId' => '<string>',
'privacyPolicyAccepted' => true,
'termsOfServiceAccepted' => true,
'phone' => '<string>',
'website' => '<string>',
'appstoreUrl' => '<string>',
'category' => '<string>',
'companyStage' => '<string>',
'hireRange' => '<string>',
'companyNiche' => '<string>',
'address' => [
'line1' => '<string>',
'line2' => '<string>',
'city' => '<string>',
'state' => '<string>',
'postal_code' => '<string>',
'country' => '<string>'
],
'instagram' => '<string>',
'linkedin' => '<string>',
'tiktok' => '<string>',
'profileImageUrl' => '<string>',
'createRequestId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.sideshift.app/api/oauth/v1/companies/create"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"parentCompanyId\": \"<string>\",\n \"privacyPolicyAccepted\": true,\n \"termsOfServiceAccepted\": true,\n \"phone\": \"<string>\",\n \"website\": \"<string>\",\n \"appstoreUrl\": \"<string>\",\n \"category\": \"<string>\",\n \"companyStage\": \"<string>\",\n \"hireRange\": \"<string>\",\n \"companyNiche\": \"<string>\",\n \"address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"instagram\": \"<string>\",\n \"linkedin\": \"<string>\",\n \"tiktok\": \"<string>\",\n \"profileImageUrl\": \"<string>\",\n \"createRequestId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.sideshift.app/api/oauth/v1/companies/create")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"parentCompanyId\": \"<string>\",\n \"privacyPolicyAccepted\": true,\n \"termsOfServiceAccepted\": true,\n \"phone\": \"<string>\",\n \"website\": \"<string>\",\n \"appstoreUrl\": \"<string>\",\n \"category\": \"<string>\",\n \"companyStage\": \"<string>\",\n \"hireRange\": \"<string>\",\n \"companyNiche\": \"<string>\",\n \"address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"instagram\": \"<string>\",\n \"linkedin\": \"<string>\",\n \"tiktok\": \"<string>\",\n \"profileImageUrl\": \"<string>\",\n \"createRequestId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.sideshift.app/api/oauth/v1/companies/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"parentCompanyId\": \"<string>\",\n \"privacyPolicyAccepted\": true,\n \"termsOfServiceAccepted\": true,\n \"phone\": \"<string>\",\n \"website\": \"<string>\",\n \"appstoreUrl\": \"<string>\",\n \"category\": \"<string>\",\n \"companyStage\": \"<string>\",\n \"hireRange\": \"<string>\",\n \"companyNiche\": \"<string>\",\n \"address\": {\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"instagram\": \"<string>\",\n \"linkedin\": \"<string>\",\n \"tiktok\": \"<string>\",\n \"profileImageUrl\": \"<string>\",\n \"createRequestId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"success": true,
"checkoutUrl": "<string>",
"companyId": "<string>",
"stripeCustomerId": "<string>",
"requiresPerClientCheckout": true,
"isFreeClient": true,
"idempotent": true,
"message": "<string>"
}
}{
"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
oauth2platformApiKey
OAuth 2.1 authorization code + PKCE (S256). Tokens are tenant-bound (company_id) and scoped. Discover endpoints via /.well-known/oauth-authorization-server.
Body
application/json
Create an agency subaccount under the token tenant. The token is confined to one company, so parentCompanyId is required and must equal your own company id (the server rejects anything else). Only an agency-parent caller may create subaccounts. Agency platform billing without bound first-client coverage, and any create once freeClientId is already set, require tier, interval, and createRequestId: the call returns a Stripe checkoutUrl, and the client is created only after a signed Stripe webhook confirms payment. Legacy per-client billing without platform billing may still create the first client immediately when freeClientId is unset. Unrecognized fields are passed through.
Subaccount company name (required).
Minimum string length:
1Parent agency id — must equal the token tenant's company id; OAuth clamps it to your own company.
Must be true — the owner accepts the privacy policy.
Must be true — the owner accepts the terms of service.
Company phone number. Optional for agency subaccounts.
Minimum string length:
1Company website URL.
Company App Store URL.
Company category.
Company stage (e.g. 'seed', 'growth').
Company hiring range.
Company niche.
Company address.
Show child attributes
Show child attributes
Instagram handle.
LinkedIn URL.
TikTok handle.
Company profile image URL.
Client plan tier. Required, together with interval, for a payment-first client checkout — agency platform billing without bound coverage, or an additional client once freeClientId is already set; missing or invalid then fails with invalid_request "Choose a client plan and billing schedule before checkout."
Available options:
starter, growth, scale Billing schedule for the client plan. Required, together with tier, on the same payment-first-checkout path as tier.
Available options:
monthly, annual Idempotency key (8-128 chars, [A-Za-z0-9_-]). Required for a payment-first client checkout (agency platform billing without bound coverage, or an additional client once freeClientId is already set); omitting it then fails with invalid_request "A client checkout request ID is required."
Response
HTTP 201 with { data: ... }. data is either the created company result (companyId, stripeCustomerId, requiresPerClientCheckout, isFreeClient, message; sometimes idempotent), or { success: true, checkoutUrl } when the request is payment-first (agency platform billing without bound coverage, or an additional client once freeClientId is set) and held pending Stripe checkout until payment. (Route returns HTTP 201; manifest successCode is 200.)
Included and legacy covered clients are created immediately. A payment-first client — including the first client on agency platform billing without bound coverage — returns checkoutUrl and is created only after confirmed payment.
- Option 1
- Option 2
Show child attributes
Show child attributes