---
title: "OnlineFormRelations.get"
method: GET
path: "/entities/OnlineFormRelations/{id}"
tags: ["Online"]
---

# OnlineFormRelations.get

`GET /entities/OnlineFormRelations/{id}`

Returns OnlineFormRelation with given id

## Path parameters

- `id` string, uuid, required

## Response `200`

OnlineFormRelation data

- object
  - `success` boolean — True when response succeeded, false on error.
  - `data` OnlineFormRelation
    - `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.
    - `account` string, uri — Account the submission is linked to, when applicable. 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` string, uri — Contact the submission is linked to, when applicable. 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.
    - `custom_entity` string, uri — Custom entity record the submission is linked to, when applicable. Relation to CustomEntity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CustomEntity' object for properties.
    - `lead` string, uri — Lead the submission is linked to. Set when lead_oppty_id resolves to a Lead. Relation to Lead. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Lead' object for properties.
    - `oppty` string, uri — Opportunity the submission is linked to. Set when lead_oppty_id resolves to an Opportunity. Relation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties.
    - `online_form` string, uri — Online form submission being linked. Relation to OnlineForm. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OnlineForm' object for properties.
    - `project` string, uri — Project the submission is linked to, when applicable. Relation to Project. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Project' object for properties.
    - `quote` string, uri — Quote the submission is linked to, when applicable. Relation to Quote. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Quote' object for properties.
    - `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.
    - `is_primary` boolean, required — True for the row that points to the submission's primary record. There is at most one primary relation per submission and its entity must match the form's entity_type.
    - `lead_oppty_id` string, uuid — Id of the linked lead or opportunity, or empty when not linked.
    - `online_form_id` string, uuid, required — Id of the submission.
    - `project_id` string, uuid — Id of the linked project.
    - `quote_id` string, uuid — Id of the linked quote.
    - `revision` integer — Revision when entity was lastly changed.

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