---
title: "Get Hosted Link session"
method: POST
path: "/link_delivery/get"
tags: ["plaid"]
---

# Get Hosted Link session

`POST /link_delivery/get`

Use the `/link_delivery/get` endpoint to get the status of a Hosted Link session.

## Request body

- LinkDeliveryGetRequest — LinkDeliveryGetRequest defines the request schema for `/link_delivery/get`
  - `client_id` string — Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
  - `secret` string — Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
  - `link_delivery_session_id` string, required — The ID for the Hosted Link session from a previous invocation of `/link_delivery/create`.

## Response `200`

OK

- LinkDeliveryGetResponse — LinkDeliveryGetRequest defines the response schema for `/link_delivery/get`
  - `status` 'CREATED' | 'OPENED' | 'EXITED' | 'COMPLETED' | 'EXPIRED', required — The status of the given Hosted Link session. `CREATED`: The session is created but not yet accessed by the user `OPENED`: The session is opened by the user but not yet completed `EXITED`: The session has been exited by the user `COMPLETED`: The session has been completed by the user `EXPIRED`: The session has expired
  - `created_at` string, date-time, required — Timestamp in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:mm:ssZ`) indicating the time the given Hosted Link session was created at.
  - `completed_at` string, date-time, nullable — Timestamp in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:mm:ssZ`) indicating the time the given Hosted Link session was completed at.
  - `request_id` string, required — A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
  - `access_tokens` AccessToken[], nullable — An array of access tokens associated with the Hosted Link session.
  - `item_ids` ItemId[], nullable — An array of `item_id`s associated with the Hosted Link session.

## Other responses

- `default` — Error response

## Changes

- **2024-02-21** `5de70cc1e6ca` — 3 warning, 11 info
  - removed the optional property `error_code_reason` from the response with the `default` status
  - removed the optional property `provided_account_subtypes` from the response with the `default` status
  - removed the optional property `required_account_subtypes` from the response with the `default` status
  - removed the `BASE_REPORT_ERROR` enum value from the `error_type` response property for the response status `default`
  - …10 more

[Change history](https://skmtc.dev/plaid/apis/the-plaid-api/changes/link_delivery/get/post.md)

---

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