curl --request GET \
--url https://dashboard.launchpointhq.com/api/v1/onboarding/{creatorId} \
--header 'x-api-key: <api-key>'import requests
url = "https://dashboard.launchpointhq.com/api/v1/onboarding/{creatorId}"
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://dashboard.launchpointhq.com/api/v1/onboarding/{creatorId}', 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://dashboard.launchpointhq.com/api/v1/onboarding/{creatorId}",
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://dashboard.launchpointhq.com/api/v1/onboarding/{creatorId}"
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://dashboard.launchpointhq.com/api/v1/onboarding/{creatorId}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://dashboard.launchpointhq.com/api/v1/onboarding/{creatorId}")
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{
"programId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"creatorId": "<string>",
"status": "waiting_for_review",
"canPost": true,
"pendingProofCount": 123,
"requiredPlatforms": [
"<string>"
],
"missingPlatforms": [
"<string>"
],
"warmUp": {
"required": true,
"status": "unavailable"
},
"accounts": [
{
"platform": "<string>",
"username": "<string>",
"met": true,
"requirements": [
{
"id": "<string>",
"type": "account_requirement",
"label": "<string>",
"instructions": "<string>",
"status": "met",
"unmetReason": "<string>",
"rejectionComments": "<string>",
"pendingProofId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
}
],
"requirementsWithoutAccount": [
{
"id": "<string>",
"label": "<string>",
"instructions": "<string>",
"platforms": [
"<string>"
]
}
],
"checklist": [
{
"label": "<string>",
"platform": "<string>",
"result": "met",
"manual": true
}
]
}Get a creator's onboarding
Everything one approved creator still needs in a program, as the dashboard’s Onboarding task shows it. It also answers for a creator with no linked account or no proof.
Approving a proof meets one requirement. Onboarding is finished when nothing is left: status is ready. status matches the dashboard: a creator in the Onboarding list has its status there; any other creator is ready, or getting_ready while they still cannot post (for example, no linked account).
curl --request GET \
--url https://dashboard.launchpointhq.com/api/v1/onboarding/{creatorId} \
--header 'x-api-key: <api-key>'import requests
url = "https://dashboard.launchpointhq.com/api/v1/onboarding/{creatorId}"
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://dashboard.launchpointhq.com/api/v1/onboarding/{creatorId}', 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://dashboard.launchpointhq.com/api/v1/onboarding/{creatorId}",
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://dashboard.launchpointhq.com/api/v1/onboarding/{creatorId}"
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://dashboard.launchpointhq.com/api/v1/onboarding/{creatorId}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://dashboard.launchpointhq.com/api/v1/onboarding/{creatorId}")
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{
"programId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"creatorId": "<string>",
"status": "waiting_for_review",
"canPost": true,
"pendingProofCount": 123,
"requiredPlatforms": [
"<string>"
],
"missingPlatforms": [
"<string>"
],
"warmUp": {
"required": true,
"status": "unavailable"
},
"accounts": [
{
"platform": "<string>",
"username": "<string>",
"met": true,
"requirements": [
{
"id": "<string>",
"type": "account_requirement",
"label": "<string>",
"instructions": "<string>",
"status": "met",
"unmetReason": "<string>",
"rejectionComments": "<string>",
"pendingProofId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
}
],
"requirementsWithoutAccount": [
{
"id": "<string>",
"label": "<string>",
"instructions": "<string>",
"platforms": [
"<string>"
]
}
],
"checklist": [
{
"label": "<string>",
"platform": "<string>",
"result": "met",
"manual": true
}
]
}Authorizations
API key created in Dashboard → Settings → Developer
Path Parameters
Opaque creator id returned by /creators
Query Parameters
Choose the data scope. company (default) limits results to the API key company's data. agency includes the parent agency and its linked brands. scope=agency requires a parent agency key; other keys receive 403.
company, agency Response
Creator onboarding returned successfully
waiting_for_review: a proof waits for your decision. getting_ready: the creator still has to do something. ready: nothing is left (detail only).
waiting_for_review, getting_ready, ready The creator may post in the program now
Platforms the program requires an account on
Required platforms without a ready account
Show child attributes
Show child attributes
The creator's accounts linked to the program
Show child attributes
Show child attributes
Custom requirements the creator cannot meet yet because no linked account is on their platforms
Show child attributes
Show child attributes
The program's onboarding checklist items for the creator
Show child attributes
Show child attributes