Check project favorite status

projectFavoriteStatus(projectReference: ID!): FavoriteStatus!

Requires project.read.

Arguments

ArgumentTypeRequiredDescription
projectReferenceID!YesProject UUID, slug or domain. An inaccessible project is not_found.

Response

Returns FavoriteStatus!. Open the type for its fields and nested types.

FieldTypeDescription
isFavoriteBoolean!Whether the caller has a favorite record for this project.
projectIdID!Identifier of the project whose favorite status was checked.

Types marked with ! cannot be null. Lists use [Type] notation. The type index lists all published input and response types.

Example

graphql
query ProjectFavoriteStatus($projectReference: ID!) {
  projectFavoriteStatus(projectReference: $projectReference) {
    projectId
    isFavorite
  }
}
json
{
  "projectReference": "00000000-0000-4000-8000-000000000001"
}