> ## Documentation Index
> Fetch the complete documentation index at: https://docs.asobeast.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Read the setup checklist of this workspace

> The goal the workspace chose, whether the checklist was hidden and up to eight items, ordered for the goal and each derived on read from rows the workspace already holds: an imported app, an app that tracks keywords in two markets, a competitor, a connected store console, a personal API token that has been used, a confirmed email alert or an active webhook, a reply the owner marked, a saved keyword field. An item that cannot be done is left out: the keyword field when the workspace has apps and none is on the App Store, the console when the instance has no store connection key, the reply until a review is stored. appId is the app a link should open (the oldest one that does not satisfy the item) and null for workspace wide items. done and total count the items listed.



## OpenAPI

````yaml /api-reference/openapi.json get /workspace/checklist
openapi: 3.0.0
info:
  title: asobeast API
  description: >-
    Self hosted ASO toolkit API.


    A metered instance carries RateLimit-Limit, RateLimit-Remaining and
    RateLimit-Reset on every response, for the tightest limit the request
    touched. A self hosted instance has no request rate limits and sends no such
    header. Limits are per workspace, so minting more tokens does not buy more
    capacity, and they are sized per plan across three classes: read for stored
    data, write for configuration changes and store for the endpoints that reach
    the App Store or Google Play.


    A 429 carries Retry-After and a rateLimit object naming the window that
    closed, or an aiAllowance object when the workspace has spent the AI calls
    its plan includes this month. A 403 with a quota object means a plan
    capacity limit such as apps or tracked keyword markets, which is a different
    problem from a rate limit. A 402 with an entitlement object means the
    workspace needs a plan.


    Positions are 1-based and null means checked but not found within the
    captured depth, never zero. Daily granularity uses UTC dates.
  version: 1.15.0
  contact: {}
servers:
  - url: http://localhost:3000/api/backend
    description: Web origin proxy
  - url: http://localhost:4000
    description: Direct API
security:
  - personalApiToken: []
tags: []
paths:
  /workspace/checklist:
    get:
      tags:
        - auth
      summary: Read the setup checklist of this workspace
      description: >-
        The goal the workspace chose, whether the checklist was hidden and up to
        eight items, ordered for the goal and each derived on read from rows the
        workspace already holds: an imported app, an app that tracks keywords in
        two markets, a competitor, a connected store console, a personal API
        token that has been used, a confirmed email alert or an active webhook,
        a reply the owner marked, a saved keyword field. An item that cannot be
        done is left out: the keyword field when the workspace has apps and none
        is on the App Store, the console when the instance has no store
        connection key, the reply until a review is stored. appId is the app a
        link should open (the oldest one that does not satisfy the item) and
        null for workspace wide items. done and total count the items listed.
      operationId: ChecklistController_read
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
components:
  securitySchemes:
    personalApiToken:
      scheme: bearer
      bearerFormat: asob
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.