> ## 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



## OpenAPI

````yaml /actionkit/openapi.json POST /projects/{project_id}/tools/#ZENDESK_SEARCH_USERS
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:
    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
                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
                  x-integration: zendesk
              required:
                - tool
                - parameters
      responses:
        '200':
          description: Success
      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.

````