Skip to main content
GET
/
api
/
v1
/
social
/
{socialId}
/
ctaitem
GET /api/v1/social/{socialId}/ctaitem
curl --request GET \
  --url https://api.scoot.app/api/v1/social/{socialId}/ctaitem \
  --header 'X-API-Key: <api-key>'
[
  {
    "CTAItemId": 123,
    "type": "URL",
    "name": "<string>",
    "text": "<string>",
    "url": "<string>",
    "x": 123,
    "y": 123,
    "imageWidth": 123,
    "imageHeight": 123,
    "buttonColor": "<string>",
    "buttonTextColor": "<string>",
    "buttonSize": "SMALL",
    "buttonVisible": true,
    "traversable": true,
    "imageURI": "<string>",
    "imageBytes": "aSDinaTvuI8gbWludGxpZnk="
  }
]
Retrieves call-to-action items configured for a specific Scootaverse session.

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
socialId
string<uuid>
required

Query Parameters

​
page
integer
default:0

Page number to get, used with pageSize

​
size
integer
default:20

Number of items to get in one request, used with page

​
sort
string

Property to sort by. Append ',' and directions 'asc/desc' to change direction

Response

200 - application/json

OK

​
CTAItemId
integer
​
type
enum<string>
Available options:
URL,
DOWNLOAD
​
name
string
​
text
string
​
url
string
​
x
integer
​
y
integer
​
imageWidth
integer
​
imageHeight
integer
​
buttonColor
string
​
buttonTextColor
string
​
buttonSize
enum<string>
Available options:
SMALL,
MEDIUM,
LARGE
​
buttonVisible
boolean
​
traversable
boolean
​
imageURI
string
​
imageBytes
string<byte>