---
title: entities.pipeline
description: Read pipeline records with the pipeline repository, and change them with the pipeline mutations. Same records as the REST Pipelines entity.
canonical: https://developers.coevera.com/reference/graphql/pipeline/
section: graphql
verification: schema
generatedFrom: schema f155746 (2026-10-20)
publisher: Coevera
---

# entities.pipeline

Read pipeline records with the pipeline repository, and change them with the pipeline mutations. Same records as the REST Pipelines entity.

REST: [Pipelines](https://developers.coevera.com/reference/rest/pipelines.md).

## Queries

- `getById(entityId: ID!): PipelineEntity` Returns the record with the given id, or null when there is none. Deleted records are returned as well.
- `getByIds(entityIds: [ID!]!): [PipelineEntity!]!` Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
- `getAll(limit: Int, offset: Int, filter: PipelineFilterInput, orderBy: [PipelineOrderByInput!], includeDeleted: Boolean): [PipelineEntity!]!` Returns the records that match the filter, paged with limit and offset.
- `getByCriteria(filter: PipelineFilterInput, orderBy: [PipelineOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int): PipelineEntityConnection` Returns the records that match the filter as a cursor-paginated connection.
- `getChangedFieldsSinceRevision(id: UUID!, revision: Int!): [UUID!]!` Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking.
- `getDefaultPipeline: PipelineEntity!` Returns the default pipeline of the space.

## Mutations

- `createPipeline(input: CreatePipelineInput!, validationLevel: [ValidationLevel!]): CreatePipelinePayload` Create one record.
- `updatePipeline(input: UpdatePipelineInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String): UpdatePipelinePayload` Update fields.
- `bulkUpdatePipeline(input: [CreateOrUpdatePipelineInput!]!, deleteInput: [DeletePipelineInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput): BulkUpdatePipelinePayload` Create or update many; per-item results.
- `deletePipeline(input: DeletePipelineInput!): DeletePipelinePayload` Soft-delete.

## Types

### PipelineEntity (object)

Sales pipeline: the ordered steps that opportunities of its opportunity types move through.

- `isDeleteProtected: Boolean!` True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only.
- `id: ID!` Unique identifier of entity.
- `isDeleted: Boolean` Specifies if the entity is considered deleted.
- `modified: DateTime` Last modification time.
- `created: DateTime` Creation time.
- `color: Int!` Display color of the pipeline label, encoded as a 24-bit RGB integer: (red << 16) | (green << 8) | blue.
- `name: String!` Name of the entity and its default text representation.
- `revision: Int` Revision when entity was lastly changed.
- `steps: [StepEntity!]!` Steps that make up this pipeline, in the order opportunities move through them.
- `opportunityTypes: [OpportunityTypeEntity!]!` Opportunity types that follow this pipeline.
- `instancePermissions: [EntityPermsEnum!]! (1 args)` Permissions the current user has on this record, out of the requested ones.

### PipelineEntityConnection (object)

Paginated list of Pipeline records.

- `pageInfo: PageInfo!` Pagination data for this connection.
- `edges: [PipelineEntityEdge]!` Contains the nodes in this connection.
- `totalCount: Int` Total number of items in the connection.

### PipelineEntityEdge (object)

A Relay edge containing a `PipelineEntity` and its cursor.

- `node: PipelineEntity` The item at the end of the edge
- `cursor: String!` A cursor for use in pagination

### PipelineFilterInput (input)

Filter conditions for Pipeline records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations.

- `OR: [PipelineFilterInput!]` Matches records that meet at least one of the listed filters.
- `AND: [PipelineFilterInput!]` Matches records that meet all of the listed filters.
- `NOT: PipelineFilterInput` Matches records that do not meet this filter.
- `globalSearchQuery: String` Search term matched against the fields that the global search covers for this entity.
- `id: EntityFilterStringField` Unique identifier of entity.
- `isDeleted: Boolean` Specifies if the entity is considered deleted.
- `modified: EntityFilterDateTimeField` Last modification time.
- `created: EntityFilterDateTimeField` Creation time.
- `color: EntityFilterNumberField` Display color of the pipeline label, encoded as a 24-bit RGB integer: (red << 16) | (green << 8) | blue.
- `name: EntityFilterStringField` Name of the entity and its default text representation.
- `revision: EntityFilterNumberField` Revision when entity was lastly changed.

### PipelineOrderByInput (input)

Sorting of Pipeline records. Set exactly one field in each item; list several items to sort by more fields, in order of priority.

- `id: OrderByEnum` Unique identifier of entity.
- `isDeleted: OrderByEnum` Specifies if the entity is considered deleted.
- `modified: OrderByEnum` Last modification time.
- `created: OrderByEnum` Creation time.
- `color: OrderByEnum` Display color of the pipeline label, encoded as a 24-bit RGB integer: (red << 16) | (green << 8) | blue.
- `name: OrderByEnum` Name of the entity and its default text representation.
- `revision: OrderByEnum` Revision when entity was lastly changed.

### CreateOrUpdatePipelineInput (input)

Field values of a Pipeline record to create, or to update when its id is set.

- `clientMutationId: String` Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
- `id: ID` Unique identifier of entity.
- `modified: DateTime` Last modification time.
- `created: DateTime` Creation time.
- `color: Int` Display color of the pipeline label, encoded as a 24-bit RGB integer: (red << 16) | (green << 8) | blue.
- `name: String` Name of the entity and its default text representation.
- `revision: Int` Revision when entity was lastly changed.
- `steps: [CreateOrUpdateStepNoPipelineBackrefInput!]` Steps that make up this pipeline, in the order opportunities move through them.

### CreateOrUpdateStepNoPipelineBackrefInput (input)

Field values of a Step record to create, or to update when its id is set, together with the record it belongs to.

- `id: ID` Unique identifier of entity.
- `modified: DateTime` Last modification time.
- `created: DateTime` Creation time.
- `description: String` Free-text description shown in the step UI.
- `hasReadonlyForm: Boolean` When true, the record form is read-only while a record is in this step.
- `hasVersionIncrement: Boolean` When true, transitioning a record into this step bumps its version counter.
- `leadProcessId: ID` Id of the lead process this step belongs to, or empty when the step is not part of a lead process.
- `name: String` Name of the entity and its default text representation.
- `percent: Int` Probability percent associated with the step (0-100). Required for opportunity pipeline steps; null for lead/quote process steps.
- `quoteProcessId: ID` Id of the quote process this step belongs to, or empty when the step is not part of a quote process.
- `sortOrder: Int` Position of the step within its pipeline or process; lower values appear first.
- `timeframe: Int` Expected number of days a record should spend in this step. Used to flag overdue records.
- `revision: Int` Revision when entity was lastly changed.
- `documents: [CreateOrUpdateCloudObjectStepRelationNoStepBackrefInput!]` Files attached to the step (e.g. step-specific documentation or templates).
- `stepChecklists: [CreateOrUpdateStepChecklistNoStepBackrefInput!]` Checklist items the user must complete before moving a record out of this step.

### CreatePipelineInput (input)

Field values of a new Pipeline record.

- `clientMutationId: String` Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
- `modified: DateTime` Last modification time.
- `created: DateTime` Creation time.
- `color: Int!` Display color of the pipeline label, encoded as a 24-bit RGB integer: (red << 16) | (green << 8) | blue.
- `name: String!` Name of the entity and its default text representation.
- `revision: Int` Revision when entity was lastly changed.
- `steps: [CreateStepNoPipelineBackrefInput!]!` Steps that make up this pipeline, in the order opportunities move through them.

### CreateStepNoPipelineBackrefInput (input)

Field values of a new Step record, created together with the record it belongs to.

- `modified: DateTime` Last modification time.
- `created: DateTime` Creation time.
- `description: String` Free-text description shown in the step UI.
- `hasReadonlyForm: Boolean` When true, the record form is read-only while a record is in this step.
- `hasVersionIncrement: Boolean` When true, transitioning a record into this step bumps its version counter.
- `leadProcessId: ID` Id of the lead process this step belongs to, or empty when the step is not part of a lead process.
- `name: String!` Name of the entity and its default text representation.
- `percent: Int` Probability percent associated with the step (0-100). Required for opportunity pipeline steps; null for lead/quote process steps.
- `quoteProcessId: ID` Id of the quote process this step belongs to, or empty when the step is not part of a quote process.
- `sortOrder: Int` Position of the step within its pipeline or process; lower values appear first.
- `timeframe: Int` Expected number of days a record should spend in this step. Used to flag overdue records.
- `revision: Int` Revision when entity was lastly changed.
- `documents: [CreateCloudObjectStepRelationNoStepBackrefInput!]` Files attached to the step (e.g. step-specific documentation or templates).
- `stepChecklists: [CreateStepChecklistNoStepBackrefInput!]` Checklist items the user must complete before moving a record out of this step.

### DeletePipelineInput (input)

Id of the Pipeline record to delete.

- `clientMutationId: String` Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
- `id: ID!` Unique identifier of entity.

### UpdatePipelineInput (input)

Id of a Pipeline record and the field values to change.

- `clientMutationId: String` Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
- `id: ID!` Unique identifier of entity.
- `modified: DateTime` Last modification time.
- `created: DateTime` Creation time.
- `color: Int` Display color of the pipeline label, encoded as a 24-bit RGB integer: (red << 16) | (green << 8) | blue.
- `name: String` Name of the entity and its default text representation.
- `revision: Int` Revision when entity was lastly changed.
- `steps: [CreateOrUpdateStepNoPipelineBackrefInput!]` Steps that make up this pipeline, in the order opportunities move through them.

### BulkUpdatePipelinePayload (object)

Result of the bulkUpdatePipeline mutation.

- `result: BulkUpdateResults!` Ids of the created, updated and deleted records, and the items that failed.

### CreatePipelinePayload (object)

Result of the createPipeline mutation.

- `pipeline: PipelineEntity` The created record.
- `clientMutationId: String` Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

### DeletePipelinePayload (object)

Result of the deletePipeline mutation.

- `pipeline: PipelineEntity` The deleted record.
- `clientMutationId: String` Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

### UpdatePipelinePayload (object)

Result of the updatePipeline mutation.

- `pipeline: PipelineEntity` The updated record.
- `clientMutationId: String` Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

Types several repositories share, such as `PageInfo` and the filter fields, are in the [types index](https://developers.coevera.com/reference/graphql/types.md). The [SDL](https://developers.coevera.com/graphql/schema.graphql) has the whole schema in one file.

## Example

```graphql
query FirstPipelines {
  entities {
    pipeline {
      getByCriteria(first: 3, orderBy: [{ modified: Desc }]) {
        totalCount
        edges { node { id name modified } }
      }
    }
  }
}
```

```bash
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"query FirstPipelines { entities { pipeline { getByCriteria(first: 3, orderBy: [{ modified: Desc }]) { totalCount edges { node { id name modified } } } } } }"}'
```