---
title: "OnlineFormTypeEmailRelations.list"
method: GET
path: "/entities/OnlineFormTypeEmailRelations"
tags: ["Online Form"]
---

# OnlineFormTypeEmailRelations.list

`GET /entities/OnlineFormTypeEmailRelations`

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

Returns a page of OnlineFormTypeEmailRelation 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 OnlineFormTypeEmailRelation records.

- object
  - `success` boolean: True when the request succeeded; false on error.
  - `data` OnlineFormTypeEmailRelation[]
    - `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.
    - `account` string, uri: Account the email recipient belongs to, when applicable. Related Account record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Account' for its fields.
    - `contact` string, uri: Contact the email was addressed to, when applicable. Related Contact record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Contact' for its fields.
    - `custom_entity` string, uri: Custom entity record the form was sent on, when applicable. Related CustomEntity record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'CustomEntity' for its fields.
    - `email` string, uri, required: Email message used to deliver the form link to the recipient. Related Email record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Email' for its fields.
    - `lead` string, uri: Lead the form was sent on. Set when lead_oppty_id resolves to a Lead. Related Lead record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Lead' for its fields.
    - `oppty` string, uri: Opportunity the form was sent on. Set when lead_oppty_id resolves to an Opportunity. Related Opportunity record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Opportunity' for its fields.
    - `online_form_type` string, uri, required: Online form being shared with the recipient via email. Related OnlineFormType record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'OnlineFormType' for its fields.
    - `quote` string, uri: Quote the form was sent on, when applicable. Related Quote record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Quote' for its fields.
    - `account_id` string, uuid: Id of the linked account.
    - `contact_id` string, uuid: Id of the linked contact.
    - `custom_entity_id` string, uuid: Id of the linked custom entity record.
    - `email_id` string, uuid, required: Id of the email message.
    - `lead_oppty_id` string, uuid: Id of the linked lead or opportunity, or empty when not linked.
    - `online_form_type_id` string, uuid, required: Id of the online form whose link the email delivers to the recipient.
    - `quote_id` string, uuid: Id of the linked quote.
    - `revision` integer: Revision when entity was lastly changed.
  - `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)