--- title: "Leads.get" method: GET path: "/entities/Leads/{id}" tags: ["Lead & Opportunity"] --- # Leads.get `GET /entities/Leads/{id}` Returns Lead with given id ## Path parameters - `id` string, uuid, required ## Response `200` Lead data - object - `success` boolean — True when response succeeded, false on error. - `data` Lead - `is_delete_protected` boolean, required — Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations. - `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. - `currency_exchange_rates_list` string, uri — Currency exchange rate list used to convert monetary fields linked to this lead. Empty to inherit the team space default. Relation to CurrencyExchangeRatesList. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CurrencyExchangeRatesList' object for properties. - `lead_source` string, uri — How the lead originated (e.g. Website, Referral, Trade Show). Configurable per team space. Relation to Data. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Data' object for properties. - `lead_type` string, uri, required — Lead type that classifies this lead. Lead types are configurable per team space and drive which form, fields and lead process apply. Relation to LeadType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'LeadType' object for properties. - `owner` string, uri — Sales user who owns this lead. May be empty when the lead is unassigned and available for take-over. Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties. - `reason_of_close` string, uri — Configurable reason recorded when the lead is archived (lost). Required when the lost form mandates it. Relation to Data. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Data' object for properties. - `step` string, uri, required — Step in the lead process the lead is currently in. Relation to Step. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Step' object for properties. - `unit` string, uri, required — Sales unit this lead is assigned to. Determines which team members can see the record under unit-based sharing. Relation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties. - `currency_exchange_rates_list_id` string, uuid — 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). Archived leads remain readable but are hidden from active lists and cannot be edited until reactivated. - `label_flag` string — User-set colored flag used to highlight the lead in lists and reports. - `last_ai_buying_center_applied` string, date-time — Time when an AI-suggested buying center was last applied to this lead. - `lead_source_id` string, uuid — Id of the lead source. - `lead_type_id` string, uuid — Id of the lead type. - `name` string, required — Name of the entity and its default text representation. - `owner_id` string, uuid — Id of the lead owner. - `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). Captured alongside reason_of_close. - `reason_of_close_id` string, uuid — Id of the reason-of-close value. - `share_mode` 0 | 1 | 2 | 3 — Sharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharing_units / sharing_clients lists control who is granted access. Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit - `step_id` string, uuid — Id of the lead process step. - `table_name` string, required — Discriminator identifying the concrete record type — always "lead" for Lead records. Read-only; useful when consuming polymorphic LeadOppty results. - `unit_id` string, uuid — Id of the sales unit. - `revision` integer — Revision when entity was lastly changed. - `primary_contact` string, uri — Primary contact of this lead. Set automatically from the contact relation marked as primary. Relation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties. - `primary_account` string, uri — Primary account of this lead. Set automatically from the account relation marked as primary. Relation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties. - `contact_relations` string[] — Contacts linked to this lead, including their roles and org-chart positions. - `account_relations` string[] — Accounts linked to this lead, including the primary-account flag. - `status` 1 | 2, required — Current status of the lead (Open, Lost, Qualified). Read-only; derived from the archived flag and lifecycle events. Integer enum value: 1 - Open, 2 - Lost - `sharing_units` string[] — Sales units that have been granted shared access to this lead. Editable only when share_mode allows unit sharing. - `sharing_clients` string[] — Users that have been granted shared access to this lead. Editable only when share_mode allows user sharing. - `documents` string[] — Documents linked to this lead. - `tags` string[] — Tag labels applied to this lead. - `static_profiles` string[] — Saved view profiles this lead currently matches. - `qualify_date` string, date-time — Timestamp of when the lead was qualified, taken from the matching KPI event. Empty for leads that have not been qualified. Read-only. - `days_in_step` integer, required — Number of days the lead has been sitting in its current pipeline step. Read-only; computed by Coevera from the most recent move event. - `is_favorite` boolean, required — True when the current authenticated user has marked this lead as favorite. Per-user. - `lost_date` string, date-time — Timestamp of when the lead was archived (lost). Setting it adjusts the underlying loss event; empty for leads that have not been archived. - `formatted_name` string, required — Display version of the lead name, used in lists and references. - `scoring` object — Lead scoring summary, combining the percentile and current scoring state. Read-only; computed by Coevera. - `modified_by_user` string, date-time — Timestamp of the most recent modification made by an end user (excluding system changes). Read-only; computed by Coevera. ## Other responses - `404` — Sent when invalid ID is given - `500` — unexpected error --- [API](https://skmtc.net/aws/apis/pipeliner-cloud-api.md) · [All operations](https://skmtc.net/aws/apis/pipeliner-cloud-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/pipeliner-cloud-api/versions/e8c12ae60aca/schema)