---
title: Leads
description: Potential deals before they are qualified. A lead moves through the steps of a lead process and becomes an opportunity when it is qualified.
canonical: https://developers.coevera.com/reference/rest/leads/
section: rest
verification: schema
generatedFrom: spec 5e43371 (2026-10-16)
publisher: Coevera
---

# Leads

Potential deals before they are qualified. A lead moves through the steps of a lead process and becomes an opportunity when it is qualified.

Qualifying a lead is a GraphQL action; REST has no action routes. A qualified lead becomes an opportunity with the same id.

> **What the API requires:** A create needs a sales unit as well as `name`: send `owner_id`, and the lead takes the owner's unit, or `unit_id` alone, and the lead waits unassigned in that unit. Without either the API answers HTTP 422, although the spec marks only `name` as required (docs sandbox, 2026-10-15).

Family: Leads and opportunities. GraphQL: [lead](https://developers.coevera.com/reference/graphql/lead.md). Base URL: `https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}`.

| Method | Path | Operation |
| --- | --- | --- |
| GET | `/entities/Leads` | List leads |
| POST | `/entities/Leads` | Create a lead |
| GET | `/entities/Leads/{id}` | Get a lead |
| PATCH | `/entities/Leads/{id}` | Update a lead |
| DELETE | `/entities/Leads/{id}` | Delete a lead |
| POST | `/entities/Leads/batch-modify` | Create or update leads in a batch |
| POST | `/entities/Leads/batch-delete` | Delete leads in a batch |
| POST | `/entities/Leads/batch-restore` | Restore deleted leads |

## List leads

`GET /entities/Leads`

Returns the leads the API application can read, one page at a time.

| Parameter | In | Type | Description |
| --- | --- | --- | --- |
| `include-deleted` | query | boolean | Include soft-deleted records. Lists only; get-by-id refuses it. |
| `first` | query | integer | Page size. Default 30, maximum 100; a larger value is refused with HTTP 400, code 117. (default 30, 1 to 100) |
| `last` | query | integer | Return the last N records of the result; together with `first`, the last N of the first M. Maximum 100. (1 to 100) |
| `before` | query | string | Cursor from `page_info.start_cursor`, to page backwards. URL-encode it. |
| `after` | query | string | Cursor from `page_info.end_cursor` of the previous page. URL-encode it: cursors are base64, and a raw + becomes a space. |
| `expand` | query | string | Related records to return inline instead of their URIs, comma-separated; dots reach nested relations, as in `account_relations.account`. |
| `order-by` | query | string | Fields to sort by, comma-separated. A leading - sorts descending, as in `-modified`; dotted paths sort by related fields. |
| `filter` | query | object | `filter[field]=value`. Separate several values with a raw comma (OR), as in `filter[name]=north,south`. Encode a comma that belongs to a value as %2C. URLSearchParams and Python requests encode every comma, so build the filter part of the query string yourself. Dotted paths filter on related records, as in `filter[owner.email]`. Encode a + in a value as %2B: query values are form-decoded, so a raw + becomes a space. |
| `filter-op` | query | object | `filter-op[field]=operator`, one per field: eq (the default), ieq, not-eq, not-ieq, contains, icontains, starts, istarts, ends, iends, gt, gte, lt, lte, between, null, not-null, empty and not-empty. null, not-null, empty and not-empty take no filter value; gt, gte, lt and lte take exactly one. |
| `load-only` | query | string | Fields to return, comma-separated (raw or encoded commas both work here); dots select nested fields, as in `owner.id`. All fields are returned without it. Lists only: get-by-id refuses it with HTTP 400, code 118. |

Responses: 200 (Page of Lead records.: `success`, `total`, `page_info`, `data`), 400, 401, 429, 500.

```bash
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Leads?first=10&filter%5Bname%5D=north&filter-op%5Bname%5D=icontains' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET"
```

## Create a lead

`POST /entities/Leads`

Creates one lead and answers 201 with the record. `name` is required, and a sales unit through `owner_id` or `unit_id`.

| Parameter | In | Type | Description |
| --- | --- | --- | --- |
| `validation-level` | query | integer | Bit mask that relaxes validation on this write. 0 (the default) validates everything. Bits: 2 skip unchanged fields, 4 skip admin-defined validations, 8 allow read-only fields, 16 skip relation checks, 32 skip value checks, 64 skip invalid recalculations, 128 skip step-checklist gates, 256 add conditional field requirements, 512 skip uniqueness checks. Add bits together (20 = 4 + 16); member names and comma lists such as 4,16 work too. A value with an internal-only bit is refused with HTTP 400, code 117. |

Request body: The new record's fields. Relations are set by id. Schema `createLeadInput`. Required: `name`.

Responses: 201 (The created Lead record.: `success`, `data`), 400, 401, 422, 429, 500.

```bash
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Leads' \
  --request POST \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Northwind Analytics - CRM rollout",
  "owner_id": "37000000-0000-4000-a000-000000000001",
  "quick_account_name": "Northwind Analytics",
  "quick_email": "northwind@example.com"
}'
```

## Get a lead

`GET /entities/Leads/{id}`

Returns one lead by id.

| Parameter | In | Type | Description |
| --- | --- | --- | --- |
| `id` | path | string (uuid) | Required. Id of the Lead record to retrieve. |
| `expand` | query | string | Related records to return inline instead of their URIs, comma-separated; dots reach nested relations. The only parameter this call accepts. |

Responses: 200 (The Lead record.: `success`, `data`), 400, 401, 404, 429, 500.

```bash
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Leads/74000000-0000-4000-a000-000000000001?expand=owner' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET"
```

## Update a lead

`PATCH /entities/Leads/{id}`

Changes the fields you send and leaves the rest as they are. Qualifying a lead is a GraphQL action, not an update.

| Parameter | In | Type | Description |
| --- | --- | --- | --- |
| `id` | path | string (uuid) | Required. Id of the Lead record to update. |
| `validation-level` | query | integer | Bit mask that relaxes validation on this write. 0 (the default) validates everything. Bits: 2 skip unchanged fields, 4 skip admin-defined validations, 8 allow read-only fields, 16 skip relation checks, 32 skip value checks, 64 skip invalid recalculations, 128 skip step-checklist gates, 256 add conditional field requirements, 512 skip uniqueness checks. Add bits together (20 = 4 + 16); member names and comma lists such as 4,16 work too. A value with an internal-only bit is refused with HTTP 400, code 117. |

Request body: The fields to change. Schema `updateLeadInput`.

Responses: 200 (The changed Lead record.: `success`, `data`), 400, 401, 404, 422, 429, 500.

```bash
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Leads/74000000-0000-4000-a000-000000000001' \
  --request PATCH \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Northwind lead (renamed)"
}'
```

## Delete a lead

`DELETE /entities/Leads/{id}`

Soft-deletes one lead and answers with its id.

| Parameter | In | Type | Description |
| --- | --- | --- | --- |
| `id` | path | string (uuid) | Required. Id of the Lead record to delete. |

Responses: 200 (Deletion confirmation.: `success`, `data`), 400, 401, 404, 429, 500.

```bash
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Leads/74000000-0000-4000-a000-000000000001' \
  --request DELETE \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET"
```

## Create or update leads in a batch

`POST /entities/Leads/batch-modify`

An item with an `id` updates that lead; an item without one creates a lead. By default one invalid item fails the whole call with HTTP 422.

| Parameter | In | Type | Description |
| --- | --- | --- | --- |
| `validation-level` | query | integer | Bit mask that relaxes validation on this write. 0 (the default) validates everything. Bits: 2 skip unchanged fields, 4 skip admin-defined validations, 8 allow read-only fields, 16 skip relation checks, 32 skip value checks, 64 skip invalid recalculations, 128 skip step-checklist gates, 256 add conditional field requirements, 512 skip uniqueness checks. Add bits together (20 = 4 + 16); member names and comma lists such as 4,16 work too. A value with an internal-only bit is refused with HTTP 400, code 117. |
| `rollback-method` | query | integer | 0, the default: one failed item fails the whole batch (HTTP 422, or 404 for an unknown id) and nothing is written. 1: the valid items are written and the call answers 200 with success false and one result per item, an id or an error, in input order. Check every item. (default 0) |

Request body: A JSON array of records: an item with an `id` updates, an item without one creates. Schema `batchLeadInput`. Required: `name`.

Responses: 200 (Result per item, in request order: the id of the created or updated record, or the error.: `success`, `data`), 400, 401, 422, 429, 500.

```bash
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Leads/batch-modify' \
  --request POST \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '[
  {
    "name": "Northwind lead"
  },
  {
    "id": "74000000-0000-4000-a000-000000000001",
    "name": "Northwind lead (renamed)"
  }
]'
```

## Delete leads in a batch

`POST /entities/Leads/batch-delete`

Soft-deletes the leads whose ids are in the body, a JSON array.

| Parameter | In | Type | Description |
| --- | --- | --- | --- |
| `rollback-method` | query | integer | 0, the default: one failed item fails the whole batch (HTTP 422, or 404 for an unknown id) and nothing is written. 1: the valid items are written and the call answers 200 with success false and one result per item, an id or an error, in input order. Check every item. (default 0) |

Request body: A JSON array of ids.

Responses: 200 (Result per id, in request order: the id of the deleted record, or the error.: `success`, `data`), 400, 401, 404, 422, 429, 500.

```bash
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Leads/batch-delete' \
  --request POST \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '[
  "74000000-0000-4000-a000-000000000001",
  "74000000-0000-4000-a000-000000000002"
]'
```

## Restore deleted leads

`POST /entities/Leads/batch-restore`

Restores the soft-deleted leads whose ids are in the body, a JSON array.

| Parameter | In | Type | Description |
| --- | --- | --- | --- |
| `rollback-method` | query | integer | 0, the default: one failed item fails the whole batch (HTTP 422, or 404 for an unknown id) and nothing is written. 1: the valid items are written and the call answers 200 with success false and one result per item, an id or an error, in input order. Check every item. (default 0) |

Request body: A JSON array of ids.

Responses: 200 (Result per id, in request order: the id of the restored record, or the error.: `success`, `data`), 400, 401, 404, 422, 429, 500.

```bash
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/Leads/batch-restore' \
  --request POST \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '[
  "74000000-0000-4000-a000-000000000001",
  "74000000-0000-4000-a000-000000000002"
]'
```

## Lead fields

| Field | Type | Notes |
| --- | --- | --- |
| `id` | uuid | Read-only. Unique identifier of entity. |
| `name` | string | Required on create. Name of the entity and its default text representation. |
| `created` | date-time | Creation time. |
| `currency_exchange_rates_list_id` | uuid → CurrencyExchangeRatesLists | Id of the currency exchange rate list applied to this lead. |
| `description` | string | Free-form description of the lead. |
| `is_archived` | boolean | True when the lead has been archived (lost). |
| `label_flag` | string | User-set colored flag used to highlight the lead in lists and reports. Values: 1, 2, 4. |
| `last_ai_buying_center_applied` | date-time | Time when an AI-suggested buying center was last applied to this lead. |
| `lead_source_id` | uuid → Data | Id of the lead source recording how the lead originated (e.g. |
| `lead_type_id` | uuid → LeadTypes | Id of the lead type that classifies the lead and drives which form, fields and lead process apply. |
| `owner_id` | uuid → Clients | Id of the lead owner; a create needs `owner_id` or `unit_id`. |
| `quick_account_email` | string | Free-text company email captured at lead creation when no Account record has been linked yet. |
| `quick_account_name` | string | Free-text company name captured at lead creation when no Account record has been linked yet. |
| `quick_account_phone` | string | Free-text company phone captured at lead creation when no Account record has been linked yet. |
| `quick_contact_name` | string | Free-text contact name captured at lead creation when no Contact record has been linked yet. |
| `quick_email` | string | Free-text contact email captured at lead creation when no Contact record has been linked yet. |
| `quick_phone` | string | Free-text contact phone captured at lead creation when no Contact record has been linked yet. |
| `ranking` | integer | Qualitative ranking score (1-10) the user assigns to indicate the strength of the lead. |
| `reason_of_close_description` | string | Free-form note explaining why the lead was archived (lost). |
| `reason_of_close_id` | uuid → Data | Id of the reason recorded when the lead is archived (lost), or empty when none was given. |
| `share_mode` | integer | Sharing model applied on top of the owner/unit visibility (e.g. Values: 0 Standard, 1 Private, 2 AllView, 3 AllEdit. |
| `step_id` | uuid → Steps | Id of the lead process step. |
| `unit_id` | uuid → SalesUnits | Id of the sales unit; a create needs `owner_id` or `unit_id`. |
| `revision` | integer | Revision when entity was lastly changed. |
| `contact_relations` | array of uri → LeadOpptyContactRelations | Contacts linked to this lead, including their roles and org-chart positions. |
| `account_relations` | array of uri → LeadOpptyAccountRelations | Accounts linked to this lead, including the primary-account flag. |
| `sharing_units` | array of uri → LeadOpptySharingSalesUnitRelations | Sales units that have been granted shared access to this lead. |
| `sharing_clients` | array of uri → LeadOpptySharingClientRelations | Users that have been granted shared access to this lead. |
| `documents` | array of uri → CloudObjectRelations | Documents linked to this lead. |
| `tags` | array of uri → TagRelations | Tag labels applied to this lead. |
| `static_profiles` | array of uri → ProfileRelations | Saved view profiles this lead currently matches. |
| `lost_date` | date-time | Timestamp of when the lead was archived (lost). |
| `is_delete_protected` | boolean | Read-only. True when the record is protected against deletion because it must always exist in the space. |
| `is_deleted` | boolean | Read-only. Specifies if the entity is considered deleted. |
| `modified` | date-time | Read-only. Last modification time. |
| `currency_exchange_rates_list` | uri → CurrencyExchangeRatesLists | Read-only. Currency exchange rate list used to convert monetary fields linked to this lead. |
| `lead_source` | uri → Data | Read-only. How the lead originated (e.g. |
| `lead_type` | uri → LeadTypes | Read-only. Lead type that classifies this lead. |
| `owner` | uri → Clients | Read-only. Sales user who owns this lead. |
| `reason_of_close` | uri → Data | Read-only. Configurable reason recorded when the lead is archived (lost). |
| `step` | uri → Steps | Read-only. Step in the lead process the lead is currently in. |
| `unit` | uri → SalesUnits | Read-only. Sales unit this lead is assigned to. |
| `table_name` | string | Read-only. Discriminator identifying the concrete record type — always "lead" for Lead records. |
| `primary_contact` | uri → Contacts | Read-only. Primary contact of this lead. |
| `primary_account` | uri → Accounts | Read-only. Primary account of this lead. |
| `status` | integer | Read-only. Current status of the lead (Open, Lost, Qualified). Values: 1 Open, 2 Lost. |
| `qualify_date` | date-time | Read-only. Timestamp of when the lead was qualified, taken from the matching KPI event. |
| `days_in_step` | integer | Read-only. Number of days the lead has been sitting in its current pipeline step. |
| `is_favorite` | boolean | Read-only. True when the current authenticated user has marked this lead as favorite. |
| `formatted_name` | string | Read-only. Display version of the lead name, used in lists and references. |
| `scoring` | object | Read-only. Lead scoring summary, combining the percentile and current scoring state. |
| `modified_by_user` | date-time | Read-only. Timestamp of the most recent modification made by an end user (excluding system changes). |

Custom fields appear in your space's live spec: `GET /api/v100/rest/spaces/{space_id}/openapi.json` with your credentials.

## Errors

Every error body has `success: false`, `http_status`, `code`, `name` and `message`. Branch on `code`: the status alone does not tell a missing permission from a bad parameter.

| HTTP | When |
| --- | --- |
| 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). |
| 422 | Validation failed (code 40000, with the failing fields) or a required parameter is missing (code 119). By default one failed item fails a whole batch and nothing is written. |
| 429 | Too many requests (code 182). Wait for the seconds in Retry-After, then retry. |
| 500 | Unexpected server error (code 1000, ERROR_UNKNOWN). |

All error codes: https://developers.coevera.com/reference/errors.md; how to handle them: https://developers.coevera.com/concepts/errors.md

## Webhook events for leads

`Lead.BackToLead`, `Lead.Create`, `Lead.Delete`, `Lead.DocumentLinked`, `Lead.Lost`, `Lead.OwnerChanged`, `Lead.Update`. Payloads: https://developers.coevera.com/webhooks/events.md

Subscribe with [Create a webhook](https://developers.coevera.com/reference/rest/webhooks.md).