CHcheckhq

List setup documents

Changed on

List all setup documents. Each document includes created_at, an ISO 8601 UTC timestamp of when Check generated this document.

get/documents/setup_documents

Request

Query parameters

companystring

Company ID

idstring[]

Filter the list to the specified IDs. For more details, check out the Bulk Get Requests guide.

Response

200

nextstring nullable

URL of the next page of results; null on the last page.

previousstring nullable

URL of the previous page of results; null on the first page.

Example response

{
  "next": "https://api.checkhq.com/documents/setup_documents?cursor=cD0lNUIlMjIyMDI0LTA3LTI2KzE2JTNBMTAlM0EwMy44OTY5ODclMkIwMCUzQTAwJTIyJTJDKyUyMjQwNTk4MSUyMiU1RA%3D%3D",
  "results": [
    {
      "id": "doc_Bw5rH2tYk8NcLq3ZsV0D",
      "company": "com_EkKTRETE3zl8CffWF2iW",
      "document_type": "payroll_journal",
      "label": "Payroll Journal",
      "created_at": "2024-09-03T14:21:55.918034Z"
    }
  ]
}

Changes

  • 5a54f5eb888bRevision changes
    • info

      added the new optional query request parameter id

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status