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

# List users

> Returns active users for the project. Filter with `?type=shared|dedicated`, batch-fetch by id with repeated `?id=uuid&id=uuid` params, or `?search=` for a partial case-insensitive match on first/last name, phone number, and email. Pagination is opt-in: omit `limit`/`offset` to return all matches (default), or pass `limit` (max 500) and `offset` to page. `total` is the count of all matches ignoring pagination. Requires Authorization: Basic base64(projectId:projectSecret).



## OpenAPI

````yaml https://spectrum.photon.codes/openapi/json get /projects/{projectId}/users/
openapi: 3.1.0
info:
  title: Spectrum Cloud External API
  description: Client-facing API for Spectrum Cloud.
  version: 1.0.0
servers:
  - url: https://spectrum.photon.codes
security: []
tags:
  - name: billing
    description: Billing and subscription operations
  - name: imessage
    description: iMessage platform operations
  - name: lines
    description: Phone line enumeration across platforms
  - name: platforms
    description: Platform management operations
  - name: users
    description: User operations
  - name: voice
    description: Voice platform operations
  - name: webhooks
    description: Webhook registration for receiving Spectrum events
  - name: whatsapp-business
    description: WhatsApp Business platform operations
  - name: slack
    description: Slack platform operations
paths:
  /projects/{projectId}/users/:
    get:
      tags:
        - users
      summary: List users
      description: >-
        Returns active users for the project. Filter with
        `?type=shared|dedicated`, batch-fetch by id with repeated
        `?id=uuid&id=uuid` params, or `?search=` for a partial case-insensitive
        match on first/last name, phone number, and email. Pagination is opt-in:
        omit `limit`/`offset` to return all matches (default), or pass `limit`
        (max 500) and `offset` to page. `total` is the count of all matches
        ignoring pagination. Requires Authorization: Basic
        base64(projectId:projectSecret).
      operationId: getProjectsByProjectIdUsers
      parameters:
        - name: projectId
          in: path
          required: true
          schema:
            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
          in: query
          required: false
          schema:
            type: string
            enum:
              - shared
              - dedicated
        - name: id
          in: query
          required: false
          schema:
            anyOf:
              - 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)$
              - type: array
                items:
                  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: search
          in: query
          required: false
          schema:
            type: string
            minLength: 1
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 500
        - name: offset
          in: query
          required: false
          schema:
            type: integer
            minimum: 0
            maximum: 1000000
      responses:
        '200':
          description: Response for status 200
          content:
            application/json:
              schema:
                type: object
                properties:
                  succeed:
                    type: boolean
                    const: true
                  data:
                    type: object
                    properties:
                      users:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            projectId:
                              type: string
                            type:
                              type: string
                              enum:
                                - shared
                                - dedicated
                            firstName:
                              anyOf:
                                - type: string
                                - type: 'null'
                            lastName:
                              anyOf:
                                - type: string
                                - type: 'null'
                            email:
                              anyOf:
                                - type: string
                                - type: 'null'
                            phoneNumber:
                              type: string
                              format: e164
                              pattern: ^\+[1-9]\d{6,14}$
                            assignedPhoneNumber:
                              type: string
                              format: e164
                              pattern: ^\+[1-9]\d{6,14}$
                            meta:
                              anyOf:
                                - type: object
                                  propertyNames:
                                    type: string
                                  additionalProperties: {}
                                - type: 'null'
                            createdAt:
                              type: string
                          required:
                            - id
                            - projectId
                            - type
                            - firstName
                            - lastName
                            - email
                            - phoneNumber
                            - assignedPhoneNumber
                            - meta
                            - createdAt
                          additionalProperties: false
                      total:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                    required:
                      - users
                      - total
                    additionalProperties: false
                required:
                  - succeed
                  - data
                additionalProperties: false

````