API EndpointsListsCheck if Entity is Saved

Check if Entity is Saved

Endpoint

URL: /:projectId/lists/is-entity-saved

Method: GET

Authentication Required: Yes


Description

Checks if a given entity is saved in any list belonging to the authenticated user.


Request

Headers

HeaderTypeRequiredDescription
AuthorizationstringYesBearer token for authentication.

Query Parameters

ParameterTypeRequiredDescription
entityIdstringYesThe ID of the entity to check for.

Example Request

GET /proj1234/lists/is-entity-saved?entityId=abc123
Authorization: Bearer <ACCESS_TOKEN>

Response

Success Response (200 OK)

true

or

false

Error Responses

Invalid Entity ID (400 Bad Request)

{
  "error": "Missing or invalid entityId in query",
  "code": "list/invalid-entity-id"
}

Server Error (500 Internal Server Error)

{
  "error": "Internal server error.",
  "code": "list/server-error",
  "details": "<Error message>"
}

Notes

  • Returns a boolean value indicating if the entity is saved in any of the user’s lists.