# Get Checklists

This API endpoint enables fetching a collection of checklists performed during a specific month and year. By providing the desired month and year as parameters, the API response narrows down the results to the exact period, facilitating the analysis of financial data and tracking the progress of checklist efforts.


Endpoint: GET /api/v1/checklists
Version: 1.0.0
Security: x-api-key

## Query parameters:

  - `filter[month]` (string, required)
    Specifies the month for which the checklists should be retrieved. Valid values are the names of the months. Must be used in conjunction with filter[year].
    Example: "march"

  - `filter[year]` (integer, required)
    Specifies the year for which the checklists should be retrieved. It should be a four-digit numerical value. Must be used in conjunction with filter[month].
    Example: 2023

  - `filter[templateId]` (string)
    templateId for which the checklists should be retrieved.
    Example: "5e94d5b63f557b001420bbb1"

  - `filter[description]` (string)
    Specifies a description for which checklists should be retrieved.
    Example: "Generate balance sheet"

  - `filter[entityId]` (string)
    Specifies the entity for which the checklists should be retrieved
    Example: "656abc949ec04a00096b56d7"

  - `page[size]` (integer)
    The number of items to return. If not specified, the API will return a default of 30,000 items, which is the maximum value.
    Example: 12000

  - `page[cursor]` (string)
    Pagination cursor that indicates the starting position for the next set of items
    Example: "5e94d5b63f557b001420bbe3"

  - `allowRedirect` (boolean)
    If set to true, the API will return a 303 redirect response if the response payload is too large. The field  will include the URL to the actual resource.
    Example: true

## Response 200 fields (application/json):

  - `data` (array)
    Array of Checklists

  - `data.id` (string)
    Id of checklist
    Example: "5e94d5b63f557b001420bbe3"

  - `data.folder` (object)

  - `data.folder.name` (string)
    Name of folder

  - `data.folder.id` (string)
    Id of folder

  - `data.templateId` (string)
    Template Id of checklist
    Example: "5e94d5b63f557b001420bbe4"

  - `data.description` (string)
    Example: "Record accrued property tax. Verify monthly accrual is 1/12th of prior year expense."

  - `data.entityId` (string)
    Example: "656abc949ec04a00096b56d7"

  - `data.period` (object)

  - `data.period.month` (string)
    Month of period
    Example: "december"

  - `data.period.year` (string)
    Year of period
    Example: "2023"

  - `data.signatures` (array)

  - `data.signatures.id` (string)
    Id of signature
    Example: "5e94d5b63f557b001420bbe5"

  - `data.signatures.group` (string)
    Enum: "preparer", "reviewer", "unassigned"

  - `data.signatures.signedDate` (string)
    Date when checklist was signed
    Example: "2021-01-01T00:00:00.000Z"

  - `data.signatures.signedBy` (string)
    Signed by user ID
    Example: "5e94d5b63f557b001420bba5"

  - `data.signatures.assignedTo` (string)
    Assigned user ID
    Example: "5e94d5b63f557b001420bba5"

  - `data.signatures.dueDate` (string)
    Date when checklist is due
    Example: "2021-01-01T00:00:00.000Z"

  - `data.signatures.metaData` (object)

  - `data.signatures.metaData.token` (string)
    API token id if this signature was signed off via API
    Example: "5e94d5b63f557b001420bbe6"

  - `data.tags` (array)

  - `data.tags.name` (string)
    Name of tag
    Example: "non_close"

  - `links` (object)

  - `links.self` (string)
    Link to self
    Example: "/api/v1/checklists?filter[month]=march&filter[year]=2023&page[size]=1000&page[cursor]=5e94d5b63f557b001420bbe3"

  - `links.next` (string)
    Pagination link pointing to the next page
    Example: "/api/v1/checklists?filter[month]=march&filter[year]=2023&page[size]=1000&page[cursor]=5e94d5b63f557b001420bbe6"

## Response 303 fields (application/json):

  - `data` (object)

  - `data.url` (string)
    The URL to the new location of the resource.

## Response 400 fields (application/json):

  - `message` (object)
    Reason(s) for the errors related to incorrect query keys or values that are out of bounds

  - `message.errors` (array)

  - `message.errors.field` (string)
    The field that caused the error
    Example: "checklistId"

  - `message.errors.message` (string)
    The error message
    Example: "checklistId is not a valid Mongo ObjectId."

  - `name` (string)
    BadRequest
    Example: "BadRequest"

  - `status` (integer)
    The HTTP status code.
    Example: 400

## Response 401 fields (application/json):

  - `message` (string)
    Reason for the error such as incorrect service access, malformed, expired or deactivated token.
    Example: "Invalid token"

  - `name` (string)
    Unauthorized
    Example: "Unauthorized"

  - `status` (integer)
    The HTTP status code.
    Example: 401

## Response 413 fields (application/json):

  - `message` (string)
    Reason for the error related to the payload size
    Example: "Response size is greater than 1MB"

  - `name` (string)
    PayloadTooLarge
    Example: "PayloadTooLarge"

  - `status` (integer)
    The HTTP status code.
    Example: 413