Get a Discover offer
curl --request GET \
--url https://app.sideshift.app/api/oauth/v1/discover/offers/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.sideshift.app/api/oauth/v1/discover/offers/{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/discover/offers/{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/discover/offers/{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/discover/offers/{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/discover/offers/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.sideshift.app/api/oauth/v1/discover/offers/{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": {
"id": "<string>",
"title": "<string>",
"description": "<string>",
"longDescription": "<string>",
"company": "<string>",
"imageUrl": "<string>",
"price": "<string>",
"faqs": [
{
"question": "<string>",
"answer": "<string>"
}
],
"companyId": "<string>",
"companyAvatarUrl": "<string>",
"bannerImageUrl": "<string>",
"calendarLink": "<string>",
"heroUrls": [
"<string>"
],
"heroCaptions": [
"<string>"
],
"videoUrls": [
"<string>"
],
"notionDocs": [
{
"title": "<string>",
"url": "<string>"
}
],
"pricingOptions": [
{
"label": "<string>",
"amount": "<string>",
"cta": "<string>",
"summary": "<string>",
"details": "<string>",
"deliverables": [
"<string>"
]
}
],
"caseStudies": [
{
"title": "<string>",
"challenge": "<string>",
"solution": "<string>",
"result": "<string>",
"link": "<string>",
"imageUrl": "<string>"
}
],
"createdAt": "<string>",
"mediaOrder": [
{
"url": "<string>"
}
],
"leadForm": {
"enabled": true,
"ctaLabel": "<string>",
"title": "<string>",
"description": "<string>",
"submitLabel": "<string>",
"successTitle": "<string>",
"successMessage": "<string>",
"includeAnswersInCalendarDescription": true,
"fields": [
{
"label": "<string>",
"id": "<string>",
"required": true,
"description": "<string>",
"placeholder": "<string>",
"options": [
{
"label": "<string>",
"id": "<string>"
}
],
"autofillSource": "active_company_website_or_appstore",
"allowOther": true,
"minSelections": 123,
"maxSelections": 123,
"maxFiles": 123,
"maxFileSizeMb": 123,
"acceptedFileTypes": [
"<string>"
],
"maxColors": 123,
"numberMin": 123,
"numberMax": 123,
"numberPrefix": "<string>",
"numberSuffix": "<string>"
}
]
},
"bookingHosts": [
{
"label": "<string>",
"calOwnerUid": "<string>",
"id": "<string>",
"isDefault": true
}
],
"calendarRouting": {
"fieldId": "<string>",
"rules": [
{
"match": {
"optionId": "<string>",
"value": true,
"min": 123,
"max": 123
},
"hostId": "<string>"
}
],
"defaultHostId": "<string>"
},
"responseTime": "<string>",
"isVerified": true,
"totalViews": 123,
"avgEngagement": 123,
"campaignCount": 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 Discover offer
a single published Discover offer by id. Requires the discover:read scope.
GET
/
discover
/
offers
/
{id}
Get a Discover offer
curl --request GET \
--url https://app.sideshift.app/api/oauth/v1/discover/offers/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.sideshift.app/api/oauth/v1/discover/offers/{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/discover/offers/{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/discover/offers/{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/discover/offers/{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/discover/offers/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.sideshift.app/api/oauth/v1/discover/offers/{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": {
"id": "<string>",
"title": "<string>",
"description": "<string>",
"longDescription": "<string>",
"company": "<string>",
"imageUrl": "<string>",
"price": "<string>",
"faqs": [
{
"question": "<string>",
"answer": "<string>"
}
],
"companyId": "<string>",
"companyAvatarUrl": "<string>",
"bannerImageUrl": "<string>",
"calendarLink": "<string>",
"heroUrls": [
"<string>"
],
"heroCaptions": [
"<string>"
],
"videoUrls": [
"<string>"
],
"notionDocs": [
{
"title": "<string>",
"url": "<string>"
}
],
"pricingOptions": [
{
"label": "<string>",
"amount": "<string>",
"cta": "<string>",
"summary": "<string>",
"details": "<string>",
"deliverables": [
"<string>"
]
}
],
"caseStudies": [
{
"title": "<string>",
"challenge": "<string>",
"solution": "<string>",
"result": "<string>",
"link": "<string>",
"imageUrl": "<string>"
}
],
"createdAt": "<string>",
"mediaOrder": [
{
"url": "<string>"
}
],
"leadForm": {
"enabled": true,
"ctaLabel": "<string>",
"title": "<string>",
"description": "<string>",
"submitLabel": "<string>",
"successTitle": "<string>",
"successMessage": "<string>",
"includeAnswersInCalendarDescription": true,
"fields": [
{
"label": "<string>",
"id": "<string>",
"required": true,
"description": "<string>",
"placeholder": "<string>",
"options": [
{
"label": "<string>",
"id": "<string>"
}
],
"autofillSource": "active_company_website_or_appstore",
"allowOther": true,
"minSelections": 123,
"maxSelections": 123,
"maxFiles": 123,
"maxFileSizeMb": 123,
"acceptedFileTypes": [
"<string>"
],
"maxColors": 123,
"numberMin": 123,
"numberMax": 123,
"numberPrefix": "<string>",
"numberSuffix": "<string>"
}
]
},
"bookingHosts": [
{
"label": "<string>",
"calOwnerUid": "<string>",
"id": "<string>",
"isDefault": true
}
],
"calendarRouting": {
"fieldId": "<string>",
"rules": [
{
"match": {
"optionId": "<string>",
"value": true,
"min": 123,
"max": 123
},
"hostId": "<string>"
}
],
"defaultHostId": "<string>"
},
"responseTime": "<string>",
"isVerified": true,
"totalViews": 123,
"avgEngagement": 123,
"campaignCount": 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
The published Discover offer.
The Discover offer. Always present (a missing offer 404s instead of returning null).
Show child attributes
Show child attributes
⌘I