---
title: "List Forwarding Requests"
method: GET
path: "/forwarding/requests"
tags: ["Forwarding"]
---

# List Forwarding Requests

`GET /forwarding/requests`

## Request

- Base URL: `https://api.justifi.ai/v1`
- URL: `https://api.justifi.ai/v1/forwarding/requests`
- Auth: none declared. Required headers: `Authorization`
- TypeScript: <https://skmtc.dev/justifi/apis/justifi-api-documentation/docs/forwarding/requests/get.ts> (a function with typed inputs; its response is checked against the schema)

List the forwarding requests for a sub account, newest first. This endpoint supports
[pagination](https://docs.justifi.tech/api-spec#section/Pagination).

## Query parameters

- `payment_method_id` string
- `created_before` string, date-time
- `created_after` string, date-time

## Headers

- `Authorization` string, required
- `Sub-Account` string

## Response `200`

Successfully list forwarding requests

- object
  - `id` number: the object id
  - `type` string: the object type, or array of objects
  - `data` ForwardingRequest[]: the list of objects
    - `id` string: unique id of the forwarding request
    - `account_id` string, nullable: the sub account that owns the payment method the request was created from
    - `payment_method_id` string, nullable: the payment method whose card details are substituted into the request body
    - `url` string: the allow-listed destination the request is sent to
    - `http_method` 'POST': the HTTP method used to reach the destination, determined by the destination itself
    - `provider` 'stripe': the destination provider, determined by the destination itself
    - `status` 'pending' | 'processing' | 'completed' | 'failed': `pending` — accepted and queued, nothing has been sent yet; `processing` — the request is being sent and the outcome is not known yet; `completed` — the destination answered, see `data.response.status_code` for the outcome; `failed` — the destination could not be reached, see `failure_reason`.
    - `failure_reason` 'timeout' | 'connection_error' | 'internal_error', nullable: why the destination could not be reached, `null` unless `status` is `failed`. `timeout` — the destination did not answer in time; `connection_error` — the connection or TLS handshake failed; `internal_error` — JustiFi failed to send the request.
    - `replacements` string[]: the card tags JustiFi found in the request body and substituted before sending
    - `request` object: what was sent to the destination, masked
      - `body` object, nullable: the request body as it was sent, with card details masked. The card number renders as its last four digits; the expiration date and cardholder name render in the clear.
      - `headers` object: the headers as they were sent, with every value replaced by `[FILTERED]`. Header names are kept so you can confirm what was relayed; values are never stored in readable form.
    - `response` object, nullable: the destination's response, `null` until the destination has answered
      - `id` string: unique id of the forwarding response
      - `status_code` integer: the HTTP status code the destination answered with
      - `body` unknown
      - `headers` unknown
      - `response_time_ms` integer, nullable: how long the destination took to answer, in milliseconds
    - `attempted_at` string, date-time, nullable: when JustiFi started sending the request (in UTC), `null` while the request is still queued
    - `created_at` string, date-time
    - `updated_at` string, date-time
  - `page_info` PageInfo
    - `end_cursor` string: the encoded id of the last record in the current list
    - `has_next` boolean: true if the collection contains records following the current list
    - `has_previous` boolean: true if the collection contains records ahead of the current list
    - `start_cursor` string: the encoded id of the first record in the current list

---

[API](https://skmtc.dev/justifi/apis/justifi-api-documentation.md) - [All operations](https://skmtc.dev/justifi/apis/justifi-api-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/justifi/apis/justifi-api-documentation/revisions/dd9f3fed7e46?raw)