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

# Get task

> Read one task definition by its ID to inspect its target, input and output schemas and whether it can be scheduled; returns the task.

`task(projectReference: String!, taskId: String!, input: SourceSelectorInput): Task!`

Requires project.runs.read.

## Arguments

| Argument | Type | Required |
| - | - | - |
| `projectReference` | [`String!`](https://veryfront.com/docs/cloud/graphql/types/string) | Yes |
| `taskId` | [`String!`](https://veryfront.com/docs/cloud/graphql/types/string) | Yes |
| `input` | [`SourceSelectorInput`](https://veryfront.com/docs/cloud/graphql/types/sourceselectorinput) | No |

## Input fields

### input

[`SourceSelectorInput`](https://veryfront.com/docs/cloud/graphql/types/sourceselectorinput)

| Field | Type | Required | Description |
| - | - | - | - |
| `sourceTargetKind` | [`SourceTargetKind`](https://veryfront.com/docs/cloud/graphql/types/sourcetargetkind) | No | The source to read; default runtimeTargetKind, else project. |
| `runtimeTargetKind` | [`RuntimeTargetKind`](https://veryfront.com/docs/cloud/graphql/types/runtimetargetkind) | No | Used as the source to read when sourceTargetKind is omitted. |
| `targetEnvironmentId` | [`ID`](https://veryfront.com/docs/cloud/graphql/types/id) | No | Required with the kind environment. |
| `targetBranchId` | [`ID`](https://veryfront.com/docs/cloud/graphql/types/id) | No | Required with the kind preview\_branch. |

## Response

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

| Field | Type | Description |
| - | - | - |
| `id` | [`ID!`](https://veryfront.com/docs/cloud/graphql/types/id) | |
| `name` | [`String!`](https://veryfront.com/docs/cloud/graphql/types/string) | |
| `description` | [`String`](https://veryfront.com/docs/cloud/graphql/types/string) | |
| `target` | [`String!`](https://veryfront.com/docs/cloud/graphql/types/string) | The execution target that implements the task. |
| `sourcePath` | [`String!`](https://veryfront.com/docs/cloud/graphql/types/string) | |
| `editMode` | [`TaskEditMode!`](https://veryfront.com/docs/cloud/graphql/types/taskeditmode) | |
| `inputSchema` | [`JSON`](https://veryfront.com/docs/cloud/graphql/types/json) | The JSON Schema of the task input, when the task declares one. |
| `outputSchema` | [`JSON`](https://veryfront.com/docs/cloud/graphql/types/json) | The JSON Schema of the task output, when the task declares one. |

[All fields of `Task`](https://veryfront.com/docs/cloud/graphql/types/task).

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 Task($projectReference: String!, $taskId: String!, $input: SourceSelectorInput) {
  task(projectReference: $projectReference, taskId: $taskId, input: $input) {
    id
    name
    description
    editMode
    inputSchema
  }
}
```

```json title="variables.json" theme={null}
{
  "projectReference": "00000000-0000-4000-8000-000000000001",
  "taskId": "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.