API ReferenceCompanions
A simple keyword-based search for your companions
Query Parameters
statuses?array<>
ethnicity?string
Value in
"black" | "asian" | "hispanic" | "indigenous" | "middleEastern" | "pacificIslander" | "southAsian" | "white" | "multiracial"gender?string
Value in
"male" | "female" | "nonBinary"search?string
tags?
pageIndex?integer
Format
int32pageSize?integer
Format
int32Header Parameters
X-API-Version?string
Response Body
curl -X GET "https://companion-api.napster.com/public/companions"{
"items": [
{
"id": "string",
"firstName": "string",
"lastName": "string",
"department": "string",
"previewUrl": "string",
"videoLoopUrl": "string",
"ethnicity": "string",
"gender": "string",
"tags": {
"property1": "string",
"property2": "string"
},
"status": "pending"
}
],
"filteredCount": 0,
"totalCount": 0,
"pageIndex": 0,
"pageSize": 0,
"search": "string"
}