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

# List Users

> API to list cursor-based paginated list of users in your workspace.

Pass the optional `tenant_id` query parameter to list only users associated with that tenant. When the filter is applied, each user object in the response also carries a `tenant` block containing the tenant-scoped property and channel overrides for that user.




## OpenAPI

````yaml GET /v1/user/
openapi: 3.1.1
info:
  title: SuprSend API
  description: APIs supported on suprsend platform
  version: 1.2.2
servers:
  - url: https://hub.suprsend.com
security:
  - sec0: []
  - BearerAuth: []
paths:
  /v1/user/:
    get:
      summary: List Users
      description: >
        API to list cursor-based paginated list of users in your workspace.


        Pass the optional `tenant_id` query parameter to list only users
        associated with that tenant. When the filter is applied, each user
        object in the response also carries a `tenant` block containing the
        tenant-scoped property and channel overrides for that user.
      operationId: list-users
      parameters:
        - name: tenant_id
          in: query
          required: false
          schema:
            type: string
          description: >-
            Filter users associated with the given tenant. When set, each result
            includes the tenant-scoped `properties` and channel overrides
            applied for this user under that tenant.
          example: acme-corp
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value:
                    meta:
                      count: 1201709
                      limit: 10
                      has_prev: false
                      before: null
                      has_next: true
                      after: 01JXXXX99APxxxxxx8Wxxxx1B
                    results:
                      - distinct_id: _distinct_id_
                        properties:
                          name: Marge Simpson
                        created_at: '2025-04-04T21:37:36.712496+00:00'
                        updated_at: '2025-04-04T21:37:36.743167+00:00'
                Filtered by tenant:
                  value:
                    meta:
                      count: 1
                      limit: 10
                      has_prev: false
                      before: null
                      has_next: false
                      after: null
                    results:
                      - distinct_id: user@example.com
                        properties:
                          name: Marge Simpson
                          role: admin
                        created_at: '2025-04-04T21:37:36.712496+00:00'
                        updated_at: '2026-07-21T09:49:36.383794+00:00'
                        $email:
                          - value: marge@example.com
                            status: active
                            perma_status: active
                        $androidpush:
                          - value: fcm_token_global_abc
                            id_provider: fcm
                            status: active
                            perma_status: active
                        tenant:
                          tenant_id: acme-corp
                          properties:
                            role: viewer
                          $email:
                            - value: marge@acme.com
                              status: active
                              perma_status: active
              schema:
                type: object
                properties:
                  meta:
                    type: object
                    description: Metadata related to pagination.
                    properties:
                      count:
                        type: integer
                        description: Total number of records available.
                        example: 1201709
                      limit:
                        type: integer
                        description: Maximum number of records per page.
                        example: 10
                      has_prev:
                        type: boolean
                        description: Indicates if there is a previous page.
                        example: false
                      before:
                        type: string
                        nullable: true
                        description: Cursor for the previous page.
                        example: null
                      has_next:
                        type: boolean
                        description: Indicates if there is a next page.
                        example: true
                      after:
                        type: string
                        description: Cursor for the next page.
                        example: 01JXXXX99APxxxxxx8Wxxxx1B
                  results:
                    type: array
                    description: List of users objects
                    items:
                      type: object
                      properties:
                        distinct_id:
                          type: string
                          description: Unique identifier of the user.
                          example: _distinct_id_
                        properties:
                          type: object
                          description: User properties (simplified)
                        created_at:
                          type: string
                          format: date-time
                          description: Timestamp when the user was created.
                          example: '2025-04-04T21:37:36.712496+00:00'
                        updated_at:
                          type: string
                          format: date-time
                          description: Timestamp when the user was last updated.
                          example: '2025-04-04T21:37:36.743167+00:00'
      deprecated: false
      security:
        - BearerAuth: []
components:
  securitySchemes:
    sec0:
      type: apiKey
      in: header
      name: Authorization
      x-bearer-format: bearer
      description: >-
        Bearer authentication header of the form `Bearer <token>`, where <token>
        is your auth token.
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API_Key
      description: >-
        Pass as `Bearer <API_KEY>`. Get API Key from SuprSend dashboard
        Developers -> API Keys section.

````