List Checks

get/v1/checks

Returns a cursor-paginated list of checks for the active workspace. Read only, no side effects. Results are scoped by workspace via row-level security; for example a paper check issued to a contractor. Attributes mirror the records field set for this root. ## Filtering & sorting Filter via `POST /v1/records/query` (root `checks`) or the `filters` model; operators are gated by each field's data type. See [Filtering & sorting](../filtering-and-sorting). **Filterable fields** | Field | Type | Allowed operators | |---|---|---| | `check_id` | text | `contains` `eq` `neq` `starts_with` `ends_with` `is_null` `is_not_null` | | `check_number` | text | `contains` `eq` `neq` `starts_with` `ends_with` `is_null` `is_not_null` | | `cmc7` | text | `contains` `eq` `neq` `starts_with` `ends_with` `is_null` `is_not_null` | | `composite_check_summary` | text | `contains` `eq` `neq` `starts_with` `ends_with` `is_null` `is_not_null` | | `composite_payment_means_list` | text | `contains` `eq` `neq` `starts_with` `ends_with` `is_null` `is_not_null` | | `created_at` | date | `eq` `lt` `gt` `is_null` `is_not_null` | | `deleted_at` | date | `eq` `lt` `gt` `is_null` `is_not_null` | | `issue_date` | date | `eq` `lt` `gt` `is_null` `is_not_null` | | `pk` | number | `eq` `neq` `gt` `gte` `lt` `lte` `is_null` `is_not_null` | | `updated_at` | date | `eq` `lt` `gt` `is_null` `is_not_null` | **Sortable fields:** `check_id`, `check_number`, `cmc7`, `composite_check_summary`, `composite_payment_means_list`, `created_at`, `deleted_at`, `issue_date`, `pk`, `updated_at` (via `orderBy` / `sort`, `asc`|`desc`).

Requires a bearer token: Authorization: Bearer <token>.

Query parameters

NameTypeRequiredDescription
cursorstringNoOpaque pagination cursor returned as links.next on the previous page. Omit to fetch the first page.e.g. eyJwayI6MTI4N30
limitintegerNoMaximum number of records to return per page (1 to 200, defaults to 50).e.g. 50
orderBystringNoField to sort by, using the records dot path or column name (e.g. created_at).e.g. created_at
directionstringNoSort direction for orderBy. Defaults to desc.e.g. desc
workspaceIdstring <uuid>NoExplicit workspace scope. The authenticated user must hold an active membership in this workspace. Defaults to the session workspace when omitted.e.g. a1b2c3d4-0000-4000-8000-000000000001

Request

cURL
curl -X GET https://api.wellapp.ai/v1/checks \
  -H "Authorization: Bearer $WELL_API_TOKEN"

Responses

200 — A page of checks.

{
  "data": [
    {
      "type": "check",
      "id": "e5f6a7b8-0000-4000-8000-0000000000a5",
      "attributes": {
        "check_id": "e5f6a7b8-0000-4000-8000-0000000000a5",
        "check_number": "001042",
        "cmc7": null,
        "issue_date": "2026-03-04",
        "created_at": "2026-03-04T16:20:00Z",
        "updated_at": "2026-03-04T16:20:00Z",
        "deleted_at": null
      },
      "relationships": {
        "company": {
          "data": {
            "type": "company",
            "id": "00000000-0000-4000-8000-000000000001"
          }
        },
        "people": {
          "data": {
            "type": "people",
            "id": "00000000-0000-4000-8000-000000000001"
          }
        },
        "payment_means": {
          "data": [
            {
              "type": "payment_means",
              "id": "00000000-0000-4000-8000-000000000001"
            }
          ]
        }
      }
    }
  ],
  "meta": {
    "total": 1,
    "count": 1
  },
  "links": {
    "next": null
  }
}

400 — Bad request

{
  "code": "BAD_REQUEST",
  "status": 400,
  "title": "Bad Request",
  "message": "See title.",
  "meta": {
    "trace_id": "a1b2c3",
    "log_id": "a1b2c3"
  }
}

401 — Unauthorized

{
  "code": "UNAUTHORIZED",
  "status": 401,
  "title": "Unauthorized",
  "message": "See title.",
  "meta": {
    "trace_id": "a1b2c3",
    "log_id": "a1b2c3"
  }
}

Filtering & sorting on related objects

Filter and sort on a related (included) object by nesting into the relationship — the same relationships you pass to include.

  • To-one relations nest directly: { "issuer": { "name": { "_eq": "Acme" } } }, and sort by a dot-path: "orderBy": { "field": "issuer.name", "direction": "asc" }.
  • To-many relations must be quantified with _some, _every, or _none: { "items": { "_some": { "quantity": { "_gt": 1 } } } }. They are not directly sortable (a to-many sort needs an aggregate proxy).
  • Composite composite_* columns are virtual — filter and sort on their underlying source fields, not on the composite.

Workspace row-level security applies at every hop, so a related-object filter never widens your tenant scope. Full operator set, deep-nesting rules, and pagination notes: Filtering & sorting.

This resource's related objects (the ones you can include) and how to filter or sort on each:

RelationshipCardinalityFilter on a fieldSort by a field
companyto-one (company){ "company": { "name": { "_eq": … } } }"field": "company.name" ✅
peopleto-one (people){ "people": { "full_name": { "_eq": … } } }"field": "people.full_name" ✅
workspaceto-one (workspace){ "workspace": { "name": { "_eq": … } } }"field": "workspace.name" ✅
payment_meansto-many (payment_means){ "payment_means": { "_some": { "field_name": { "_eq": … } } } }aggregate proxy only ⚠️

Replace field_name with any field of the related object. See its object-reference page for the full field list.

Filter by a to-one relation (and sort by it):

{
  "root": "checks",
  "whereClause": { "company": { "name": { "_ilike": "%acme%" } } },
  "orderBy": { "field": "company.name", "direction": "asc" }
}

Filter by a to-many relation (quantified — bare nesting is invalid):

{
  "root": "checks",
  "whereClause": { "payment_means": { "_some": { "field_name": { "_gt": 0 } } } }
}