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

# List Replier workspaces

> Lists the workspaces you belong to, with your role and permissions in each, the plan, and the Free Plan allowance. Every other request is made in one of these workspaces.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/workspaces
openapi: 3.1.0
info:
  title: Replier API
  version: '1'
servers:
  - url: https://api.usereplier.com
security:
  - apiKey: []
paths:
  /v1/workspaces:
    get:
      tags:
        - Workspaces
      summary: List Replier workspaces
      description: >-
        Lists the workspaces you belong to, with your role and permissions in
        each, the plan, and the Free Plan allowance. Every other request is made
        in one of these workspaces.
      operationId: list_workspaces
      parameters: []
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  workspaces:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                          pattern: >-
                            ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                        name:
                          type: string
                        kind:
                          type: string
                          enum:
                            - personal
                            - agency
                        role:
                          type: string
                          enum:
                            - owner
                            - admin
                            - member
                        permissions:
                          type: array
                          items:
                            type: string
                        plan:
                          description: >-
                            null: no paid plan. Personal workspaces then run on
                            the Free Plan's monthly allowance; runs over it are
                            skipped with reason quota_exceeded.
                          anyOf:
                            - type: string
                              enum:
                                - creator
                                - studio
                            - type: 'null'
                        free_plan_allowance:
                          description: >-
                            The Free Plan's monthly allowance, counted in
                            interactions: one per automation run whose first
                            message (a gate prompt or the DM) went out, plus
                            sends under way; a gate prompt and its DM, or a
                            multi-message flow run, count once. Once used
                            reaches limit, matching comments are skipped with
                            reason quota_exceeded until resets_at. Null on a
                            paid plan.
                          anyOf:
                            - type: object
                              properties:
                                used:
                                  type: integer
                                  minimum: 0
                                  maximum: 9007199254740991
                                limit:
                                  type: integer
                                  exclusiveMinimum: 0
                                  maximum: 9007199254740991
                                resets_at:
                                  anyOf:
                                    - type: string
                                      format: date-time
                                      pattern: >-
                                        ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
                                    - type: 'null'
                              required:
                                - used
                                - limit
                                - resets_at
                            - type: 'null'
                        service_status:
                          description: >-
                            active: sending. grace: a payment is overdue or
                            incomplete, but automations keep sending until the
                            grace period ends. paused: no automation in this
                            workspace sends, even when enabled; settings and
                            data are kept.
                          type: string
                          enum:
                            - active
                            - grace
                            - paused
                        setup_status:
                          type: string
                          enum:
                            - active
                            - checkout_pending
                            - setup_pending
                            - migration_running
                            - migration_failed
                      required:
                        - id
                        - name
                        - kind
                        - role
                        - permissions
                        - plan
                        - service_status
                        - setup_status
                required:
                  - workspaces
        default:
          $ref: '#/components/responses/Error'
components:
  responses:
    Error:
      description: Refused
      content:
        application/json:
          schema:
            type: object
            required:
              - error
            properties:
              error:
                type: object
                required:
                  - code
                  - message
                properties:
                  code:
                    type: string
                    description: >-
                      Why the request was refused, such as AUTOMATION_NOT_FOUND
                      or VERSION_CONFLICT. Other fields beside it give details.
                  message:
                    type: string
                    description: The same reason, in English.
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: A Replier API key (rpl_...).

````

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