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

# Search Users

**Provider API:** Zendesk Support API (v2).


## OpenAPI

````yaml actionkit/openapi.json POST /projects/{project_id}/tools/#ZENDESK_SEARCH_USERS_V2
openapi: 3.0.0
info:
  title: ActionKit Tools API
  version: 1.0.0
servers:
  - url: https://actionkit.useparagon.com
    description: US Cloud
security: []
paths:
  /projects/{project_id}/tools/#ZENDESK_SEARCH_USERS_V2:
    post:
      summary: Search Users
      parameters:
        - name: project_id
          in: path
          required: true
          schema:
            type: string
            description: >-
              Your Paragon Project ID. You can copy your Project ID from your
              dashboard URL or by clicking Copy Project ID under the Environment
              switcher.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                tool:
                  type: string
                  default: ZENDESK_SEARCH_USERS_V2
                parameters:
                  type: object
                  properties:
                    name:
                      type: string
                      description: 'Name : Filter results by the user’s name.'
                    email:
                      type: string
                      description: >-
                        Email : Filter results by the user’s email. (example:
                        "jane@example.com")
                    role:
                      type: string
                      description: Role
                      enum:
                        - admin
                        - agent
                        - end-user
                    externalId:
                      type: string
                      description: 'External ID : Filter by users by their external ID.'
                    sort_by:
                      type: string
                      description: Sort By
                      enum:
                        - created_at
                        - updated_at
                    sort_order:
                      type: string
                      description: Sort Order
                      enum:
                        - asc
                        - desc
                    paginationParameters:
                      type: object
                      description: Pagination Parameters
                      properties:
                        pageCursor:
                          type: string
                          description: >-
                            The cursor to use for requesting additional results.
                            Use if you received a previous response with a page
                            cursor and require more results.
                        limit:
                          type: number
                          description: >-
                            The maximum number of records to load in one page of
                            results.
                  x-integration: zendesk
              required:
                - tool
                - parameters
      responses:
        '200':
          description: >-
            A page of matching Zendesk users, each with `result_type: "user"`. A
            full page has 100 users. `nextPageCursor` is `null` on the last
            page; otherwise pass it as `paginationParameters.pageCursor` to load
            the next page. Zendesk search returns at most 1,000 results, so
            `nextPageCursor` is `null` once that limit is reached.
          content:
            application/json:
              examples:
                Response (first page):
                  summary: First page, more pages available (abbreviated)
                  value:
                    records:
                      - id: 360000020441
                        url: >-
                          https://example.zendesk.com/api/v2/users/360000020441.json
                        name: Docs Test User
                        email: docs-test-user@example.com
                        created_at: '2026-10-16T05:54:36Z'
                        updated_at: '2026-10-16T05:54:42Z'
                        time_zone: America/New_York
                        iana_time_zone: America/New_York
                        phone: '+15555550123'
                        shared_phone_number: false
                        photo: null
                        locale_id: 1
                        locale: en-US
                        organization_id: null
                        role: end-user
                        verified: true
                        external_id: null
                        tags: []
                        alias: null
                        active: true
                        shared: false
                        shared_agent: false
                        last_login_at: null
                        two_factor_auth_enabled: null
                        signature: null
                        details: null
                        notes: null
                        role_type: null
                        custom_role_id: null
                        is_billing_admin: null
                        moderator: false
                        ticket_restriction: requested
                        only_private_comments: false
                        restricted_agent: false
                        suspended: false
                        default_group_id: null
                        report_csv: false
                        user_fields: {}
                        result_type: user
                    nextPageCursor: '2'
                Response (last page):
                  summary: Last page
                  value:
                    records:
                      - id: 360000020441
                        url: >-
                          https://example.zendesk.com/api/v2/users/360000020441.json
                        name: Docs Test User
                        email: docs-test-user@example.com
                        created_at: '2026-10-16T05:54:36Z'
                        updated_at: '2026-10-16T05:54:42Z'
                        time_zone: America/New_York
                        iana_time_zone: America/New_York
                        phone: '+15555550123'
                        shared_phone_number: false
                        photo: null
                        locale_id: 1
                        locale: en-US
                        organization_id: null
                        role: end-user
                        verified: true
                        external_id: null
                        tags: []
                        alias: null
                        active: true
                        shared: false
                        shared_agent: false
                        last_login_at: null
                        two_factor_auth_enabled: null
                        signature: null
                        details: null
                        notes: null
                        role_type: null
                        custom_role_id: null
                        is_billing_admin: null
                        moderator: false
                        ticket_restriction: requested
                        only_private_comments: false
                        restricted_agent: false
                        suspended: false
                        default_group_id: null
                        report_csv: false
                        user_fields: {}
                        result_type: user
                    nextPageCursor: null
      security:
        - BearerAuth: []
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Your [Paragon User
        Token](/getting-started/installing-the-connect-sdk#setup) (JWT), which
        you can generate using your project's signing keys.

````