---
title: "List pay applications"
method: GET
path: "/pay-apps"
tags: ["PayApps"]
---

# List pay applications

`GET /pay-apps`

## Request

- Base URL: `https://app.buildworkpro.com/api/v1`
- URL: `https://app.buildworkpro.com/api/v1/pay-apps`
- Auth: HTTP bearer

Returns a cursor-paginated list of pay apps for the authenticated tenant.

## Query parameters

- `limit` integer
- `cursor` string
- `status` string
- `projectId` integer, nullable
- `search` string
- `dateFrom` string, date-time
- `dateTo` string, date-time
- `compact` boolean: Return compact row projection (id + key fields only).

## Response `200`

PayApps page

- object
  - `data` PayApp[], required
    - `id` integer, required
    - `payAppNumber` string, required
    - `projectId` integer, required
    - `status` string, required
    - `periodStart` string, date, nullable, required
    - `periodEnd` string, date, nullable, required
    - `contractSum` string, nullable, required
    - `changeOrdersTotal` string, nullable, required
    - `revisedContractSum` string, nullable, required
    - `previouslyBilled` string, nullable, required
    - `currentBilled` string, nullable, required
    - `materialsStored` string, nullable, required
    - `totalCompleted` string, nullable, required
    - `retainagePercent` string, nullable, required
    - `retainageAmount` string, nullable, required
    - `currentPaymentDue` string, nullable, required
    - `notes` string, nullable
    - `includeNotary` boolean: Print the notary acknowledgment block on the pay application PDF. Defaults to true.
    - `createdAt` union, required
      - string, date-time
      - string
    - `updatedAt` union, required
      - string, date-time
      - string
  - `meta` ResponseMeta, required
    - `request_id` string: Server-generated request identifier
    - `pagination` PaginationMeta
      - `cursor` string, nullable, required: Opaque cursor for the next page; null when no more results
      - `has_more` boolean, required: Whether more pages are available after this one
      - `count` integer, required: Items in this page

## Other responses

- `403`: Error

---

[API](https://skmtc.dev/buildworkpro/apis/buildworkpro-api.md) · [All operations](https://skmtc.dev/buildworkpro/apis/buildworkpro-api/llms.txt) · [OpenAPI document](https://skmtc.dev/buildworkpro/apis/buildworkpro-api/revisions/441cf40012f7?raw)