List agent labels

agentLabels(input: ProjectAgentLabelsInput!): AgentLabelList!

Requires project.agents.read.

Arguments

ArgumentTypeRequired
inputProjectAgentLabelsInput!Yes

Input fields

input

ProjectAgentLabelsInput

FieldTypeRequiredDescription
projectReferenceStringNo
agentIdID!Yes
sourceTargetKindStringNoSource target: project, main_branch, or preview_branch. Null and omission select project.
targetBranchIdIDNo

Response

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

FieldType
labels[AgentLabel!]!

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

Example

graphql
query AgentLabels($input: ProjectAgentLabelsInput!) {
  agentLabels(input: $input) {
    labels {
      id
      projectId
      createdAt
      updatedAt
      color
    }
  }
}
json
{
  "input": {
    "projectReference": "00000000-0000-4000-8000-000000000001",
    "agentId": "00000000-0000-4000-8000-000000000001"
  }
}