📡 API Reference

Favorite Endpoints

Manage user favorites — bookmark entities (tasks, projects, contacts) for quick access.

Base Path

/api/favorite

Endpoints

List Favorites

GET /api/favorite
Authorization: Bearer {token}

Add to Favorites

POST /api/favorite
Authorization: Bearer {token}
Content-Type: application/json

{
  "entity": "OrganizationProject",
  "entityId": "project-uuid",
  "organizationId": "uuid"
}

Remove from Favorites

DELETE /api/favorite/:id
Authorization: Bearer {token}

Supported Entities

Entity TypeDescription
TaskTasks
OrganizationProjectProjects
OrganizationContactCRM contacts
OrganizationTeamTeams
EmployeeEmployees

Data Model

interface IFavorite {
  id: string;
  entity: string;
  entityId: string;
  employeeId: string;
  organizationId: string;
  tenantId: string;
}

Edit this page

Copyright © 2023-Present Ever Co. LTD.Docs by Sourcey