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

# Approvals.get

`GET /entities/Approvals/{id}`

Returns Approval with given id

## Path parameters

- `id` string, uuid, required

## Response `200`

Approval data

- object
  - `success` boolean — True when response succeeded, false on error.
  - `data` Approval
    - `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 approval is requested on, when the trigger record is an Account. 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.
    - `actor` string, uri — User who triggered the approval, or empty when triggered automatically. 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.
    - `application` string, uri, required — Application context the approval was triggered in. Relation to Application. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Application' object for properties.
    - `approval_process` string, uri, required — Approval process this approval was raised from. Relation to ApprovalProcess. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ApprovalProcess' object for properties.
    - `contact` string, uri — Contact the approval is requested on, when the trigger record is a Contact. 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.
    - `lead` string, uri — Lead the approval is requested on. 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 approval is requested on. 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.
    - `quote` string, uri — Quote the approval is requested on, when the trigger record is a Quote. 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.
    - `actor_id` string, uuid — Id of the triggering user.
    - `application_id` string, uuid, required — Id of the application.
    - `approval_process_id` string, uuid, required — Id of the approval process.
    - `approval_status` 0 | 1 | 2 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 0 - Pending, 1 - Approved, 2 - Rejected
    - `comment` string — Comment the requester attached when raising the approval.
    - `contact_id` string, uuid — Id of the linked contact.
    - `end_time` string, date-time — Timestamp the approval reached a final status (Approved/Rejected/Cancelled). Empty while the approval is still pending.
    - `lead_oppty_id` string, uuid — Id of the linked lead or opportunity, or empty when not linked.
    - `quote_id` string, uuid — Id of the linked quote.
    - `settings` object, required — Snapshot of the approval process schema at the time the approval was raised. Frozen so subsequent changes to the parent approval process do not affect this run.
    - `status` 1 | 2 | 3 | 4 | 5 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - Ok, 2 - Warning, 3 - Error, 4 - Scheduled, 5 - Expired
    - `revision` integer — Revision when entity was lastly changed.
    - `approvers` string[] — Users who must respond to the approval, with their individual responses.
    - `lines` string[] — Activity log lines describing the steps taken on this approval (visible only).
    - `start_time` string, date-time — Timestamp the approval was raised (alias of created).

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