---
title: "OpportunityTypes.list"
method: GET
path: "/entities/OpportunityTypes"
tags: ["Lead & Opportunity"]
---

# OpportunityTypes.list

`GET /entities/OpportunityTypes`

Returns all defined OpportunityTypes

## Query parameters

- `include-deleted` boolean
- `first` integer
- `last` integer
- `before` string
- `after` string
- `expand` string
- `order-by` string
- `filter` object
- `filter-op` object
- `load-only` string

## Response `200`

list of OpportunityTypes

- object
  - `success` boolean — True when response succeeded, false on error.
  - `data` OpportunityType[]
    - `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.
    - `pipeline` string, uri, required — Pipeline this opportunity type drives. Each opportunity type maps to exactly one pipeline. Relation to Pipeline. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Pipeline' object for properties.
    - `form_edit` object — JSON definition of the form layout used by the UI when creating or editing opportunities of this type.
    - `form_lost` object — JSON definition of the form shown when archiving (losing) an opportunity of this type. Used to capture reason of close and any required closing fields.
    - `form_qualify` object — JSON definition of the form shown when qualifying a lead into an opportunity of this type.
    - `form_won` object — JSON definition of the form shown when winning an opportunity of this type. Used to capture won-deal fields.
    - `is_readonly` boolean, required — True when the opportunity type is system-managed and cannot be edited or deleted by users.
    - `name` string, required — Name of the entity and its default text representation.
    - `pipeline_id` string, uuid, required — Id of the pipeline.
    - `settings` string, binary, required — Per-type configuration for records of this entity type, e.g. allowed task and appointment types that may be linked to records of this type.
    - `is_published` boolean — True when the entity configuration is published; false while it exists only as an unpublished draft.
    - `revision` integer — Revision when entity was lastly changed.
    - `has_draft` boolean, required — Set to True if draft for entity exists and can be published
    - `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.
    - `form_edit_api` object, required — API-friendly form definition. Returns the published form merged with any pending draft changes; read via this field, modify via the underlying form_edit / form_lost field through drafts.
    - `can_change_readonly` boolean — Returns if user can change readonly flag on this entity_type.
    - `form_lost_api` object, required — API-friendly form definition. Returns the published form merged with any pending draft changes; read via this field, modify via the underlying form_edit / form_lost field through drafts.
    - `form_qualify_api` object[], required — List of field ids selected on a derived form (qualify or won transition). Read-only; modify the underlying form_qualify / form_won field through drafts.
    - `form_won_api` object[], required — List of field ids selected on a derived form (qualify or won transition). Read-only; modify the underlying form_qualify / form_won field through drafts.
  - `page_info` object — Page info result set. Please note it is returned only when legacy limit & offset parameters are not used.
    - `start_cursor` string — Start cursor of result set.
    - `end_cursor` string — End cursor of result set.
    - `has_previous_page` boolean — If result set has previous page (if yes, use start_cursor value in before parameter to load it).
    - `has_next_page` boolean — If result set has next page (if yes, use end_cursor value in after parameter to load it).

## Other responses

- `500` — unexpected error

---

[API](https://skmtc.dev/aws/apis/pipeliner-cloud-api.md) · [All operations](https://skmtc.dev/aws/apis/pipeliner-cloud-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/aws/pipeliner-cloud-api/revisions/e8c12ae60aca/schema)