Favorites

Lists the current user's favorites for a project.

Lists the current user's favorites for a project. Optionally filtered by entityType. Returns stale rows when the underlying entity has been deleted - clients render a gone-state with a one-click 'Remove from favorites' affordance.

get/api/v1/favorites

Request

  • Base URL: https://uniform.app
  • URL: https://uniform.app/api/v1/favorites
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer

Query parameters

projectIdstring required

Project the favorites belong to.

entityType'entry' | 'composition' | 'component' | 'contentType' | 'blockType' | 'entryPattern' | 'componentPattern' | 'compositionPattern' | 'asset'

Optional filter; omit to list every favorite for the project.

offsetnumber nullable

Number of records to skip.

limitnumber

Maximum number of records to return.

Response

OK

totalCountnumber required

Changes

No recorded changes to this operation across all 1 revision of this API.