--- title: "ClientFavorites.list" method: GET path: "/entities/ClientFavorites" tags: ["Client"] --- # ClientFavorites.list `GET /entities/ClientFavorites` ## Request - Base URL: `https://us-east.api.coevera.com/api/v100/rest/spaces/your_space_id` - URL: `https://us-east.api.coevera.com/api/v100/rest/spaces/your_space_id/entities/ClientFavorites` - Auth: HTTP basic - TypeScript: (a function with typed inputs; its response is checked against the schema) Returns a page of ClientFavorite records, optionally filtered, sorted and limited to selected fields. ## Query parameters - `include-deleted` boolean - `first` integer - `last` integer - `before` string - `after` string - `expand` string - `order-by` string - `filter` object - `filter-op` object - `load-only` string ## Response `200` Page of ClientFavorite records. - object - `success` boolean: True when the request succeeded; false on error. - `data` ClientFavorite[] - `is_delete_protected` boolean, required: True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. - `id` string, uuid, required: Unique identifier of entity. - `is_deleted` boolean: Specifies if the entity is considered deleted. - `modified` string, date-time: Last modification time. - `created` string, date-time: Creation time. - `account` string, uri: Account marked as favorite, when this favorite points to an account. Related Account record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Account' for its fields. - `appointment` string, uri: Appointment marked as favorite. Set when activity_id resolves to an Appointment. Related Appointment record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Appointment' for its fields. - `task` string, uri: Task marked as favorite. Set when activity_id resolves to a Task. Related Task record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Task' for its fields. - `contact` string, uri: Contact marked as favorite, when this favorite points to a contact. Related Contact record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Contact' for its fields. - `custom_entity` string, uri: Custom entity record marked as favorite, when this favorite points to a custom entity. Related CustomEntity record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'CustomEntity' for its fields. - `email` string, uri: Email marked as favorite, when this favorite points to an email. Related Email record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Email' for its fields. - `lead` string, uri: Lead marked as favorite. Set when lead_oppty_id resolves to a Lead. Related Lead record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Lead' for its fields. - `oppty` string, uri: Opportunity marked as favorite. Set when lead_oppty_id resolves to an Opportunity. Related Opportunity record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Opportunity' for its fields. - `owner` string, uri, required: User who marked the record as favorite. Related Client record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Client' for its fields. - `profile` string, uri: Screen profile marked as favorite, when this favorite points to a profile. Related Profile record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Profile' for its fields. - `project` string, uri: Project marked as favorite, when this favorite points to a project. Related Project record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Project' for its fields. - `quote` string, uri: Quote marked as favorite, when this favorite points to a quote. Related Quote record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Quote' for its fields. - `report` string, uri: Report marked as favorite, when this favorite points to a report. Related Report record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Report' for its fields. - `account_id` string, uuid: Id of the favorite account. - `activity_id` string, uuid: Id of the favorite appointment or task, or empty when not pointing to an activity. - `contact_id` string, uuid: Id of the favorite contact. - `custom_entity_id` string, uuid: Id of the favorite custom entity record. - `email_id` string, uuid: Id of the favorite email. - `lead_oppty_id` string, uuid: Id of the favorite lead or opportunity, or empty when not pointing to one. - `owner_id` string, uuid, required: Id of the owning user. - `profile_id` string, uuid: Id of the favorite screen profile. - `project_id` string, uuid: Id of the favorite project. - `quote_id` string, uuid: Id of the favorite quote. - `report_id` string, uuid: Id of the favorite report. - `revision` integer: Revision when entity was lastly changed. - `page_info` object: Pagination of the result; not returned when the legacy limit and offset parameters are used. - `start_cursor` string: Cursor of the first record of the page. - `end_cursor` string: Cursor of the last record of the page. - `has_previous_page` boolean: Whether records exist before this page; pass start_cursor as before to load them. - `has_next_page` boolean: Whether records exist after this page; pass end_cursor as after to load them. - `total` integer: Number of records that match the request, across all pages. ## Other responses - `400`: Bad request: a bad or unknown parameter (codes 117, 118), a missing permission (code 50), conflicting data (code 2002) or any other API error. The REST API answers 400 where others answer 403 or 409; check `code`. - `401`: Not authenticated: missing or wrong credentials, a credential of another space, or an expired token (code 401, ERROR_UNAUTHORIZED). - `429`: Too many requests (code 182). Wait for the seconds in Retry-After, then retry. - `500`: Unexpected server error (code 1000, ERROR_UNKNOWN). --- [API](https://skmtc.dev/coevera/apis/coevera-crm-api.md) - [All operations](https://skmtc.dev/coevera/apis/coevera-crm-api/llms.txt) - [OpenAPI document](https://skmtc.dev/coevera/apis/coevera-crm-api/revisions/40ebbc83f179?raw)