---
title: "LeadProcesses.get"
method: GET
path: "/entities/LeadProcesses/{id}"
tags: ["Lead & Opportunity"]
---

# LeadProcesses.get

`GET /entities/LeadProcesses/{id}`

## Request

- Base URL: `https://us-east.api.coevera.com/api/v100/rest/spaces/your_space_id`
- URL: `https://us-east.api.coevera.com/api/v100/rest/spaces/your_space_id/entities/LeadProcesses/{id}`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/coevera/apis/coevera-crm-api/docs/entities/LeadProcesses/:id/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns the LeadProcess record with the given id.

## Path parameters

- `id` string, uuid, required

## Query parameters

- `expand` string

## Response `200`

The LeadProcess record.

- object
  - `success` boolean: True when the request succeeded; false on error.
  - `data` LeadProcess: Lead process: the ordered steps that leads of its lead types move through.
    - `is_delete_protected` boolean, required: 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` string, uuid, required: Unique identifier of entity.
    - `is_deleted` boolean: Specifies if the entity is considered deleted.
    - `modified` string, date-time: Last modification time.
    - `created` string, date-time: Creation time.
    - `color` integer: Display color of the lead process label, encoded as an integer packing the RGB components: (red << 16) | (green << 8) | blue.
    - `name` string, required: Name of the entity and its default text representation.
    - `revision` integer: Revision when entity was lastly changed.
    - `steps` BatchStepInput[], required: Steps that make up this lead process, in evaluation order.
      - `description` string: Free-text description shown in the step UI.
      - `has_readonly_form` boolean: When true, the record form is read-only while a record is in this step.
      - `has_version_increment` boolean: When true, transitioning a record into this step bumps its version counter.
      - `lead_process_id` string, uuid: 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` integer: Probability percent associated with the step (0-100). Required for opportunity pipeline steps; null for lead/quote process steps.
      - `quote_process_id` string, uuid: Id of the quote process this step belongs to, or empty when the step is not part of a quote process.
      - `sort_order` integer: Position of the step within its pipeline or process; lower values appear first.
      - `timeframe` integer: Expected number of days a record should spend in this step. Used to flag overdue records.
      - `revision` integer: Revision when entity was lastly changed.
      - `documents` object[]: Files attached to the step (e.g. step-specific documentation or templates).
        - `id` string, uuid: Id of the related CloudObjectStepRelation record.
      - `step_checklists` object[]: Checklist items the user must complete before moving a record out of this step.
        - `id` string, uuid: Id of the related StepChecklist record.
      - `id` string, uuid: ID of object to update.
    - `lead_types` string[], required: Lead types that follow this lead process.

## Other responses

- `400`: Bad request: a bad or unknown parameter (codes 117, 118), a missing permission (code 50), conflicting data (code 2002) or any other API error. The REST API answers 400 where others answer 403 or 409; check `code`.
- `401`: Not authenticated: missing or wrong credentials, a credential of another space, or an expired token (code 401, ERROR_UNAUTHORIZED).
- `404`: No such record or entity (code 143 ERROR_NO_ENTITY, or 2006 ERROR_UNKNOWN_TYPE).
- `429`: Too many requests (code 182). Wait for the seconds in Retry-After, then retry.
- `500`: Unexpected server error (code 1000, ERROR_UNKNOWN).

---

[API](https://skmtc.dev/coevera/apis/coevera-crm-api.md) - [All operations](https://skmtc.dev/coevera/apis/coevera-crm-api/llms.txt) - [OpenAPI document](https://skmtc.dev/coevera/apis/coevera-crm-api/revisions/40ebbc83f179?raw)