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

# Team Role List

> List the roles a ChatSyncs team member can have via the API: which modules each role can use and its monthly limits. Use when a developer asks what a team member's role allows, or needs a role_id.

Lists the roles a team member can have. Each role names the modules it can use (`module_ids`) and its
monthly limits (`monthly_limit`, returned as a JSON string such as `{"1":"1","19":"3000"}`).

## Example Request

```bash theme={null}
curl --request GET \
  --url 'https://platform.chatsyncs.com/api/v1/user/package/list?apiToken=API-KEY'
```

<Note>
  This endpoint is named after packages because a role is stored as a package of type `team`. Match a role to a person
  through the `role_id` that [Team Member List](/developer-api/user/list-team-members) returns.
</Note>


## OpenAPI

````yaml GET /user/package/list
openapi: 3.1.0
info:
  title: ChatSyncs Developer API
  version: 1.0.0
  description: >-
    REST API for sending WhatsApp messages and managing subscribers through
    ChatSyncs.


    **Authentication.** Send your key as the `apiToken` parameter, or as
    `Authorization: Bearer <key>` — both work on every endpoint. A wrong key
    returns HTTP 401 `{"status":"0","message":"Unauthenticated."}`; no key at
    all redirects to the login page.


    **Methods.** Every endpoint accepts both GET and POST with the same
    parameters, except Upload Media, which is POST-only. Use POST for anything
    that changes data.


    **Errors.** Failures usually come back as HTTP 200 with `"status":"0"` and
    the reason in `message`, so always check `status`. `status` is the string
    `"1"` or `"0"` on most endpoints and a boolean on a few.


    **Lists.** Endpoints that return rows put them in `message` as a list; there
    is no `data` field (Custom Fields List is the exception and uses `data`).
servers:
  - url: https://platform.chatsyncs.com/api/v1
security: []
paths:
  /user/package/list:
    get:
      tags:
        - User API
      summary: Team Role List
      description: >-
        Lists the roles a team member can have: which modules each can use
        (`module_ids`) and its monthly limits (`monthly_limit`, a JSON string).
      operationId: listTeamRoles
      parameters:
        - name: apiToken
          in: query
          required: true
          schema:
            type: string
            example: API-KEY
          description: >-
            Your ChatSyncs API key (not a WhatsApp/Meta access token). [Where to
            find it](/developer-api/finding-ids#api-token-apitoken).
      responses:
        '200':
          description: >-
            Standard ChatSyncs response. `status` is `"1"` on success and `"0"`
            on failure.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    description: '`"1"` = success, `"0"` = failure.'
                  message:
                    type: array
                    description: The rows.
              examples:
                success:
                  summary: Success
                  value:
                    status: '1'
                    message:
                      - id: 16151
                        package_name: Support Role
                        package_type: team
                        price: '0'
                        validity: 0
                        module_ids: 1,19,18
                        monthly_limit: '{"1":"1","19":"3000"}'
                        visible: '1'
                error:
                  summary: Error
                  value:
                    status: '0'
                    message: Invalid request.
        '401':
          description: >-
            `apiToken` is wrong. (With no token at all the API redirects to the
            login page with HTTP 302 instead of returning JSON.)
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  message:
                    type: string
              examples:
                unauthenticated:
                  summary: Wrong apiToken
                  value:
                    status: '0'
                    message: Unauthenticated.

````

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