> ## Documentation Index
> Fetch the complete documentation index at: https://veryfront.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Check project favorite status

> Returns whether the caller has favorited the project, as is_favorite.

`projectFavoriteStatus(projectReference: ID!): FavoriteStatus!`

Requires project.read.

## Arguments

| Argument | Type | Required | Description |
| - | - | - | - |
| `projectReference` | [`ID!`](https://veryfront.com/docs/cloud/graphql/types/id) | Yes | Project UUID, slug or domain. An inaccessible project is not\_found. |

## Response

Returns [`FavoriteStatus!`](https://veryfront.com/docs/cloud/graphql/types/favoritestatus). Open the type for its fields and nested types.

| Field | Type | Description |
| - | - | - |
| `isFavorite` | [`Boolean!`](https://veryfront.com/docs/cloud/graphql/types/boolean) | Whether the caller has a favorite record for this project. |
| `projectId` | [`ID!`](https://veryfront.com/docs/cloud/graphql/types/id) | Identifier of the project whose favorite status was checked. |

Types marked with `!` cannot be null. Lists use `[Type]` notation. The [type index](https://veryfront.com/docs/cloud/graphql/schema.md) lists all published input and response types.

## Example

```graphql title="query.graphql" theme={null}
query ProjectFavoriteStatus($projectReference: ID!) {
  projectFavoriteStatus(projectReference: $projectReference) {
    projectId
    isFavorite
  }
}
```

```json title="variables.json" theme={null}
{
  "projectReference": "00000000-0000-4000-8000-000000000001"
}
```

<details>
  <summary>Try this query</summary>

  Calls use `https://api.veryfront.com/graphql`. Replace sample values with resources you can access. See [Authentication](https://veryfront.com/docs/cloud/authentication.md) for credentials and permissions.

  Bearer token or API key

  Stored in this tab's session. Clear credential

  Query

  Variables (JSON)
</details>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.