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

# OpportunityTypes.list

`GET /entities/OpportunityTypes`

## 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/OpportunityTypes`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/coevera/apis/coevera-crm-api/docs/entities/OpportunityTypes/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns a page of OpportunityType records, optionally filtered, sorted and limited to selected fields.

## 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`

Page of OpportunityType records.

- object
  - `success` boolean: True when the request 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. Related Pipeline record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Pipeline' for its fields.
    - `form_edit` object: JSON definition of the form layout used by the UI when creating or editing opportunities of this type. This payload conforms to the `Form` JSON Schema (see the linked schema).
    - `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. This payload conforms to the `Form` JSON Schema (see the linked schema).
    - `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 this opportunity type drives.
    - `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. This payload conforms to the `EntityTypeSettings` JSON Schema (see the linked schema).
    - `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: True when the record has unpublished draft changes, including pending translation changes, that can be published.
    - `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.
    - `form_edit_api` object, required: Typed, read-only view of a form layout of this type: form_edit_api mirrors the edit form (form_edit), form_lost_api the form shown when archiving as lost (form_lost).
    - `can_change_readonly` boolean: False for types whose read-only setting is fixed, such as the recurrent appointment type; true otherwise.
    - `form_lost_api` object, required: Typed, read-only view of a form layout of this type: form_edit_api mirrors the edit form (form_edit), form_lost_api the form shown when archiving as lost (form_lost).
    - `form_qualify_api` object[], required: Ids of the fields shown on the form when a lead is qualified into an opportunity of this type. Read-only view of `formQualify`.
    - `form_won_api` object[], required: Ids of the fields shown on the form when an opportunity of this type is won. Read-only view of `formWon`.
  - `page_info` object: Pagination of the result; not returned when the legacy limit and offset parameters are used.
    - `start_cursor` string: Cursor of the first record of the page.
    - `end_cursor` string: Cursor of the last record of the page.
    - `has_previous_page` boolean: Whether records exist before this page; pass start_cursor as before to load them.
    - `has_next_page` boolean: Whether records exist after this page; pass end_cursor as after to load them.
  - `total` integer: Number of records that match the request, across all pages.

## 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).
- `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)