---
title: "List orders"
method: GET
path: "/v1/orders/"
tags: ["Orders"]
---

# List orders

`GET /v1/orders/`

The endpoint returns a list of orders.

## Query parameters

- `created_at__lte` string, date-time
- `created_at__gte` string, date-time
- `expired_at__lte` string, date-time
- `expired_at__gte` string, date-time
- `source` 'floify' | 'besmartee' | 'lenderlogix' | 'encompass_consumer_connect' | 'byte' | 'core_logic' | 'xactus' | 'constellation' | 'banno' | 'mx' | 'q2' | 'clutch' | 'accio' | 'encompass' | 'tpo_connect' | 'darkmatter' | 'tazworks' | 'internal' | 'simplenexus' | 'external_webpage' | 'individual' | 'self_signup' | 'alkami' | 'blue_sage' | 'lodasoft' | 'blend' | 'tidalwave'
- `status` string[]
- `products` string[]
- `refresh` 'only' | 'exclude'
- `order_manager_emails` string
- `templates` string
- `search` string
- `ordering` 'created_at' | '-created_at' | 'refreshed_at' | '-refreshed_at' | 'expired_at' | '-expired_at' | 'order_number' | '-order_number' | 'order_manager__email' | '-order_manager__email' | 'notes' | '-notes'
- `cursor` string
- `page_size` integer

## Response `200`

- PaginatedOrderListResponse
  - `next` string, uri, nullable — URL to the next page of results
  - `previous` string, uri, nullable — URL to the previous page of results
  - `results` OrderListItem[]
    - `id` string, required — Unique ID
    - `order_number` string, nullable — External ID
    - `products` string[], required — Types of products selected for the order
    - `source` 'floify' | 'besmartee' | 'lenderlogix' | 'encompass_consumer_connect' | 'byte' | 'core_logic' | 'xactus' | 'constellation' | 'banno' | 'mx' | 'q2' | 'clutch' | 'accio' | 'encompass' | 'tpo_connect' | 'darkmatter' | 'tazworks' | 'internal' | 'simplenexus' | 'external_webpage' | 'individual' | 'self_signup' | 'alkami' | 'blue_sage' | 'lodasoft' | 'blend' | 'tidalwave', required — Type of the platform (internal, accio, etc.)
    - `custom_field` string, nullable — User provided custom field. Must be enabled in the customization section.
    - `first_name` string, required — First name
    - `last_name` string, required — Last name
    - `short_share_url` string, uri, nullable — Shortened verification URL to share
    - `created_at` string, date-time, required — Date and time when order was created
    - `canceled_at` string, date-time, nullable — Date and time when order was canceled
    - `expired_at` string, date-time, nullable — Date and time when the order is scheduled to expire
    - `initial_order` string, nullable — ID of an origin order if the order was created by the order data refresh operation
    - `refresh_order` string, nullable — ID of the last refresh order created by the order data refresh operation for the order
    - `manager` object, nullable — Order manager info associated with an order.
      - `email` string, email, required — Email of the order manager
      - `name` string — Name of the order manager
    - `loan` OrderListLoanInline, nullable — Loan Information
      - `loan_number` string, nullable — Loan identifier
      - `application_number` string, nullable — Application (POS) file number
      - `originator_name` string, nullable — Name of the loan originator
      - `originator_email` string, email, nullable — Email of the loan originator
      - `loan_processor_name` string, nullable — Name of the loan processor
      - `loan_processor_email` string, email, nullable — Email of the loan processor
    - `template` OrderListTemplateInline, nullable — Customization template applied to the order
      - `id` string — ID of the template
      - `name` string — Name of the template
    - `notes` string, nullable — Free text field for notes associated with the order
    - `employers` OrderListEmployer[] — List of employers
      - `id` string, required — Unique ID
      - `product_type` 'income' | 'employment' | 'deposit_switch' | 'pll' — Type of the product.
      - `status` 'pending' | 'sent' | 'completed' | 'error' | 'canceled' | 'expired' | 'no_data' | 'skipped', required — Order status
      - `suborder_number` string, nullable — External ID
      - `created_at` string, date-time, required — Date and time when order was created
      - `link_id` string, nullable — Link ID for the connected account
      - `data_source` 'payroll' | 'docs' | 'tax' | 'financial_accounts' | 'null', nullable — Source of data: payroll - payroll provider parsing, docs - user uploaded documents, tax - tax documents, financial_accounts - bank data.
      - `provider` object, nullable — Payroll or insurance provider
        - `id` string, nullable, required — Provider id
        - `name` string, required — Provider name
        - `logo_url` string, uri, nullable — Provider logo url
      - `is_suspicious` boolean — Flag to indicate if the data from the source is suspicious. E.g. fraud detected in uploaded documents or SSN of the user does not match with the data
      - `was_attempted` boolean — Whether the user attempted this connection
    - `insurance` OrderListInsurance, nullable — Insurance connection, when this order includes the insurance product
      - `id` string, required — Unique ID
      - `product_type` 'insurance' — Type of the product.
      - `status` 'pending' | 'sent' | 'completed' | 'error' | 'canceled' | 'expired' | 'no_data' | 'skipped', required — Order status
      - `suborder_number` string, nullable — External ID
      - `created_at` string, date-time, required — Date and time when order was created
      - `link_id` string, nullable — Link ID for the connected account
      - `data_source` 'insurance' | 'docs' | 'null', nullable — Source of data: insurance - insurance data, docs - user uploaded documents.
      - `provider` object, nullable — Payroll or insurance provider
        - `id` string, nullable, required — Provider id
        - `name` string, required — Provider name
        - `logo_url` string, uri, nullable — Provider logo url
      - `is_suspicious` boolean — Flag to indicate if the data from the source is suspicious. E.g. fraud detected in uploaded documents or SSN of the user does not match with the data
      - `was_attempted` boolean — Whether the user attempted this connection
    - `financial_accounts` OrderListBank[], nullable — List of financial accounts
      - `id` string, required — Unique ID
      - `product_type` 'transactions' | 'assets' — Type of the product.
      - `status` 'pending' | 'sent' | 'completed' | 'error' | 'canceled' | 'expired' | 'no_data' | 'skipped', required — Order status
      - `suborder_number` string, nullable — External ID
      - `created_at` string, date-time, required — Date and time when order was created
      - `link_id` string, nullable — Link ID for the connected account
      - `data_source` 'financial_accounts' | 'null', nullable — Source of data: financial_accounts - bank data.
      - `provider` object, nullable — Payroll or insurance provider
        - `id` string, nullable, required — Provider id
        - `name` string, required — Provider name
        - `logo_url` string, uri, nullable — Provider logo url
      - `is_suspicious` boolean — Flag to indicate if the data from the source is suspicious. E.g. fraud detected in uploaded documents or SSN of the user does not match with the data
      - `was_attempted` boolean — Whether the user attempted this connection

## Other responses

- `400` — HTTP 400 Bad Request
- `401` — HTTP 401 Unauthorized
- `403` — HTTP 403 Forbidden
- `429` — HTTP 429 Too Many Requests

---

[API](https://skmtc.net/truv/apis/truv-api.md) · [All operations](https://skmtc.net/truv/apis/truv-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/truv/truv-api/versions/b92671dcb52d/schema)