Favorites
Favorites API endpoints
Authorization
bearerAuth AuthorizationBearer <token>
API key via Authorization: Bearer <API_KEY>
In: header
Query Parameters
itemType?string
Value in
"page" | "workflow" | "schedule"itemIds?string
Response Body
application/json
application/json
curl -X GET "http://localhost:3013/api/favorites"{
"favorites": [
{
"id": "string",
"userId": "string",
"itemType": "page",
"itemId": "string",
"createdAt": "string",
"lastUpdatedAt": "string",
"createdBy": "string",
"updatedBy": "string"
}
],
"favoriteIds": [
"string"
]
}{
"error": "string",
"property1": null,
"property2": null
}Authorization
bearerAuth AuthorizationBearer <token>
API key via Authorization: Bearer <API_KEY>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X PUT "http://localhost:3013/api/favorites" \ -H "Content-Type: application/json" \ -d '{ "itemType": "page", "itemId": "string", "favorite": true }'{
"favorite": true,
"itemType": "page",
"itemId": "string",
"row": {
"id": "string",
"userId": "string",
"itemType": "page",
"itemId": "string",
"createdAt": "string",
"lastUpdatedAt": "string",
"createdBy": "string",
"updatedBy": "string"
}
}{
"error": "string",
"property1": null,
"property2": null
}