Get Checks

get/v1/checks/{check_id}

Fetches a single check by its public id within the active workspace. Read only, no side effects. Returns 404 when the id is unknown or falls outside the caller's workspace scope.

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

Path parameters

Name	Type	Required	Description
check_id	string <uuid>	Yes	Public UUID of the check.e.g. e5f6a7b8-0000-4000-8000-0000000000a5

Query parameters

Name	Type	Required	Description
workspaceId	string <uuid>	No	Explicit 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/{check_id} \
  -H "Authorization: Bearer $WELL_API_TOKEN"

Responses

200 — The requested check.

{
  "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"
          }
        ]
      }
    }
  }
}

401 — Unauthorized

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

404 — Not found

{
  "code": "NOT_FOUND",
  "status": 404,
  "title": "Not Found",
  "message": "See title.",
  "meta": {
    "trace_id": "a1b2c3",
    "log_id": "a1b2c3"
  }
}