> ## 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.

# List deployments

> List deployments.

`deployments(projectReference: String!, environmentId: ID, limit: Int, cursor: String, sortBy: String, sortOrder: DeploymentSortOrder): DeploymentsConnection!`

Requires project.deployments.read.

## Arguments

| Argument | Type | Required | Description |
| - | - | - | - |
| `projectReference` | [`String!`](https://veryfront.com/docs/cloud/graphql/types/string) | Yes | Project UUID, slug or configured domain. |
| `environmentId` | [`ID`](https://veryfront.com/docs/cloud/graphql/types/id) | No | Only deployments of this environment of the project. |
| `limit` | [`Int`](https://veryfront.com/docs/cloud/graphql/types/int) | No | Deployments per page, between 1 and 100. Defaults to 20. |
| `cursor` | [`String`](https://veryfront.com/docs/cloud/graphql/types/string) | No | pageInfo.endCursor of the previous page. |
| `sortBy` | [`String`](https://veryfront.com/docs/cloud/graphql/types/string) | No | Sort field. Only created\_at. |
| `sortOrder` | [`DeploymentSortOrder`](https://veryfront.com/docs/cloud/graphql/types/deploymentsortorder) | No | Sort direction by creation time. Defaults to desc. |

## Response

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

| Field | Type |
| - | - |
| `data` | [`[Deployment!]!`](https://veryfront.com/docs/cloud/graphql/types/deployment) |
| `pageInfo` | [`PageInfo!`](https://veryfront.com/docs/cloud/graphql/types/pageinfo) |

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 Deployments($projectReference: String!, $environmentId: ID, $limit: Int, $cursor: String, $sortBy: String, $sortOrder: DeploymentSortOrder) {
  deployments(projectReference: $projectReference, environmentId: $environmentId, limit: $limit, cursor: $cursor, sortBy: $sortBy, sortOrder: $sortOrder) {
    data {
      id
      createdAt
      updatedAt
      environmentId
      releaseId
    }
    pageInfo {
      hasNextPage
      endCursor
      hasPreviousPage
      startCursor
    }
  }
}
```

```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.