Sign in

3d9b9702e0e3

latestOpenAPI 3.0.12026-08-1089235683.9 KB
Orders

List orders

The endpoint returns a list of orders.

get/v1/orders/

Query parameters

created_at__ltestring date-time

Filter created_at less than or equal (ISO-8601).

created_at__gtestring date-time

Filter created_at greater than or equal (ISO-8601).

expired_at__ltestring date-time

Filter expired_at less than or equal (ISO-8601).

expired_at__gtestring date-time

Filter expired_at greater than or equal (ISO-8601).

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'
Example:floify

Filter by order source.

statusstring[]

Filter by order status.

[
  "completed"
]
productsstring[]

Filter by product type.

[
  "income",
  "assets"
]
refresh'only' | 'exclude'
Example:exclude

Filter refresh orders: only returns refresh orders, exclude returns original orders.

order_manager_emailsstring

Comma-separated list of order manager emails to filter orders.

templatesstring

Comma-separated list of customization template IDs to filter orders.

user_idstring
Example:99dd17074ac94aa9ace2621d657c7610

Filter orders by user ID.

distinct_by_userboolean

When set to true, returns only the most recent order per user.

searchstring

Search query by the following fields: id, applicant_report_id, voa_report_id, phone, email, order_number, loan_number, application_number, custom_field, first_name, last_name, company_name.

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'
Example:-created_at

Which field to use when ordering the results. The default is by descending created_at.

cursorstring

The pagination cursor value.

page_sizeinteger

Number of results to return per page.

Response

OR

Example response

{
  "next": "https://prod.truv.com/v1/orders/?cursor=cD0yMDI2LTA0LTIx",
  "previous": "https://prod.truv.com/v1/orders/?cursor=cj0xJnA9MjAyNi0wNC0yMQ",
  "results": [
    {
      "id": "39aa1486ccca4bc19cda071ffc1ba392",
      "user_id": "99dd17074ac94aa9ace2621d657c7610",
      "order_number": "1534332",
      "products": [
        "income",
        "assets"
      ],
      "source": "floify",
      "first_name": "John",
      "last_name": "Doe",
      "short_share_url": "https://truv.com/s/BIlEyh1A",
      "created_at": "2026-04-21T21:45:14.418542Z",
      "canceled_at": "2026-04-22T21:45:14.418542Z",
      "expired_at": "2026-04-23T21:45:14.418542Z",
      "initial_order": "f5dc0239e2094dbc90ab2edc1918a9df",
      "refresh_order": "9b96606355b94e8abff8ed8d75aa2027",
      "manager": {
        "email": "john.doe@example.com",
        "name": "John Doe"
      },
      "loan": {
        "loan_number": "MUUT220700012",
        "application_number": "APP-2207-0001",
        "originator_name": "John Doe",
        "originator_email": "john@example.com",
        "loan_processor_name": "John Doe",
        "loan_processor_email": "john@doe.com"
      },
      "template": {
        "id": "9b96606355b94e8abff8ed8d75aa2027",
        "name": "My template"
      },
      "notes": "To be processed by John Doe",
      "employers": [
        {
          "id": "ad9f14440d624ec3b0f66e81e44518c7",
          "product_type": "income",
          "status": "pending",
          "suborder_number": "133982343355",
          "created_at": "2026-04-21T22:12:59.346109Z",
          "link_id": "e4100fccdae94691b4414c7306220c06",
          "data_source": "payroll",
          "provider": {
            "id": "truv_api",
            "name": "Sandbox Provider",
            "logo_url": "https://cdn.truv.com/providers/truv-blue.svg"
          },
          "was_attempted": true
        }
      ],
      "insurance": {
        "id": "ad9f14440d624ec3b0f66e81e44518c7",
        "product_type": "insurance",
        "status": "pending",
        "suborder_number": "133982343355",
        "created_at": "2026-04-21T22:12:59.346109Z",
        "link_id": "e4100fccdae94691b4414c7306220c06",
        "data_source": "insurance",
        "provider": {
          "id": "truv_api",
          "name": "Sandbox Provider",
          "logo_url": "https://cdn.truv.com/providers/truv-blue.svg"
        },
        "was_attempted": true
      },
      "financial_accounts": [
        {
          "id": "ad9f14440d624ec3b0f66e81e44518c7",
          "product_type": "assets",
          "status": "pending",
          "suborder_number": "133982343355",
          "created_at": "2026-04-21T22:12:59.346109Z",
          "link_id": "e4100fccdae94691b4414c7306220c06",
          "data_source": "financial_accounts",
          "provider": {
            "id": "truv_api",
            "name": "Sandbox Provider",
            "logo_url": "https://cdn.truv.com/providers/truv-blue.svg"
          },
          "was_attempted": true
        }
      ]
    }
  ]
}