Zendesk
Zendesk Users API

The Zendesk Users API is part of the Zendesk Support REST API and lets you programmatically manage the people in your accountend users, agents, and admins. It provides endpoints to list, search, create, update, and delete users; manage roles, tags, custom fields, organization and group memberships; handle user identities (such as email addresses and phone numbers) and verification; set avatars; suspend or reactivate accounts; and merge duplicate users.
Documentation GitHub OpenAPI
OpenAPI Specification

openapi: 3.1.0
info:
  version: "1.0"
  title: Zendesk Users
  description: Needs a description.
paths:
  /api/v2/channels/voice/agents/{agent_id}/users/{user_id}/display:
    post:
      operationId: OpenUsersProfileInAgentBrowser
      tags:
        - Basics
      summary: Zendesk Post  Api V2 Channels Voice Agents Agent_id Users User_id Display
      description: |-
        Allows you to instruct an agent's browser to open a user's profile.

        When the message is successfully delivered to an agent's browser:

        ```http
        Status: 200 OK
        ```

        When `agent_id` or `user_id` is invalid:

        ```http
        Status: 404 Not Found
        ```

        #### Allowed For
        * Agents
      parameters:
        - $ref: '#/components/parameters/AgentId'
        - $ref: '#/components/parameters/UserId'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: string
                description: empty
                example: ''
              example: ''
        '404':
          description: When the `agent_id` or `user_id` is invalid
          content:
            application/json:
              schema:
                type: string
                description: Invalid attribute
                example: ''
              example: ''
  /api/v2/incremental/users:
    parameters:
      - $ref: '#/components/parameters/IncrementalUnixTime'
      - $ref: '#/components/parameters/IncrementalPage'
    get:
      operationId: IncrementalUserExportTime
      tags:
        - Incremental Export
      summary: Zendesk Get  Api V2 Incremental Users
      description: >
        #### Allowed For

         * Admins

        #### Sideloading


        See [Users
        sideloads](/documentation/ticketing/using-the-zendesk-api/side_loading/#supported-endpoints).
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TimeBasedExportIncrementalUsersResponse'
              examples:
                default:
                  $ref: >-
                    #/components/examples/TimeBasedExportIncrementalUsersResponseExample
  /api/v2/incremental/users/cursor:
    parameters:
      - $ref: '#/components/parameters/IncrementalUnixTime'
      - $ref: '#/components/parameters/IncrementalCursor'
      - $ref: '#/components/parameters/IncrementalPage'
    get:
      operationId: IncrementalUserExportCursor
      tags:
        - Incremental Export
      summary: Zendesk Get  Api V2 Incremental Users Cursor
      description: >
        #### Allowed For

         * Admins

        #### Sideloading


        See [Users
        sideloads](/documentation/ticketing/using-the-zendesk-api/side_loading/#supported-endpoints).
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CursorBasedExportIncrementalUsersResponse'
              examples:
                default:
                  $ref: >-
                    #/components/examples/CursorBasedExportIncrementalUsersResponseExample
  /api/v2/users:
    get:
      operationId: ListUsers
      tags:
        - Users
      summary: Zendesk Get  Api V2 Users
      description: |
        #### Pagination

        * Cursor pagination (recommended)
        * Offset pagination

        See [Pagination](/api-reference/introduction/pagination/).

        Returns a maximum of 100 records per page.

        #### Allowed For

        * Admins, Agents and Light Agents
      parameters:
        - $ref: '#/components/parameters/UserRoleFilter'
        - $ref: '#/components/parameters/UserRolesFilter'
        - $ref: '#/components/parameters/UserPermissionSetFilter'
        - $ref: '#/components/parameters/UserExternalIdFilter'
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsersResponse'
              examples:
                default:
                  $ref: '#/components/examples/UsersResponseExample'
    post:
      operationId: CreateUser
      tags:
        - Users
      summary: Zendesk Post  Api V2 Users
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserRequest'
            examples:
              default:
                $ref: '#/components/examples/UserRequestExample'
      responses:
        '201':
          description: Created response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserResponse'
              examples:
                default:
                  $ref: '#/components/examples/UserCreateResponseExample'
  /api/v2/users/{user_id}:
    parameters:
      - $ref: '#/components/parameters/UserId'
    get:
      operationId: ShowUser
      tags:
        - Users
      summary: Zendesk Get  Api V2 Users User_id
      description: |
        #### Allowed For

        * Agents
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserResponse'
              examples:
                default:
                  $ref: '#/components/examples/UserResponseExample'
    put:
      operationId: UpdateUser
      tags:
        - Users
      summary: Zendesk Put  Api V2 Users User_id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserRequest'
            examples:
              default:
                $ref: '#/components/examples/UpdateUserRequestExample'
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserResponse'
              examples:
                default:
                  $ref: '#/components/examples/UpdateUserResponseExample'
    delete:
      operationId: DeleteUser
      tags:
        - Users
      summary: Zendesk Delete  Api V2 Users User_id
      description: >
        Deletes the user and associated records from the account.


        **Warning**:


        * Deleted users are not recoverable.

        * Both agents and administrators can soft delete users in the agent
        interface in Zendesk Support. Agents with permission can delete end
        users, while administrators can delete all users except the account
        owner.


        To comply with GDPR, a further step is needed. See [Permanently Delete
        User](/api-reference/ticketing/users/users/#permanently-delete-user).


        #### Allowed For


        * Admins and [agents in custom roles with
        permission](https://support.zendesk.com/hc/en-us/articles/4408882153882#topic_cxn_hig_bd)
        to manage end users or team members
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserResponse'
              examples:
                default:
                  $ref: '#/components/examples/DeleteUserResponseExample'
  /api/v2/users/{user_id}/compliance_deletion_statuses:
    parameters:
      - $ref: '#/components/parameters/UserId'
    get:
      operationId: ShowUserComplianceDeletionStatuses
      tags:
        - Users
      summary: Zendesk Get  Api V2 Users User_id Compliance_deletion_statuses
      description: >
        Returns the GDPR status for each user per area of compliance. A Zendesk
        area of compliance is typically a product like "support/explore" but can
        be more fine-grained for areas within the product lines.


        If the user is not in the account, the request returns a 404 status.


        ```http

        Status: 404

        {
          "error":"RecordNotFound",
          "description":"Not found"
        }

        ```


        #### Allowed For


        * Agents, with restrictions


        #### Pagination


        * Cursor pagination (recommended)

        * Offset pagination


        See [Pagination](/api-reference/introduction/pagination/).
      parameters:
        - name: application
          in: query
          description: Area of compliance
          schema:
            type: string
          example: chat
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComplianceDeletionStatusesResponse'
              examples:
                default:
                  $ref: >-
                    #/components/examples/ComplianceDeletionStatusesResponseExample
  /api/v2/users/{user_id}/group_memberships/{group_membership_id}/make_default:
    parameters:
      - $ref: '#/components/parameters/UserId'
      - $ref: '#/components/parameters/GroupMembershipId'
    put:
      operationId: GroupMembershipSetDefault
      tags:
        - Group Memberships
      summary: >-
        Zendesk Put  Api V2 Users User_id Group_memberships Group_membership_id Make_default
      description: |
        #### Allowed For:

        * Agents
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupMembershipsResponse'
              examples:
                default:
                  $ref: '#/components/examples/GroupMembershipsResponseExample'
  /api/v2/users/{user_id}/identities:
    parameters:
      - $ref: '#/components/parameters/UserId'
      - name: type[]
        in: query
        description: >-
          Filters results by one or more identity types using the format
          `?type[]={type}&type[]={type}`
        explode: true
        schema:
          type: string
          enum:
            - email
            - facebook
            - phone_number
            - sdk
            - twitter
            - messaging
            - microsoft
    get:
      operationId: ListUserIdentities
      tags:
        - User Identities
      summary: Zendesk Get  Api V2 Users User_id Identities
      description: >
        Returns a list of identities for the given user.


        Use the first endpoint if authenticating as an agent. Use the second if
        authenticating as an end user. End users can only list email and phone
        number identities.


        #### Pagination


        * Cursor pagination (recommended)

        * Offset pagination


        See [Pagination](/api-reference/introduction/pagination/).


        Returns a maximum of 100 records per page for cursor pagination.


        #### Allowed For


        * Agents

        * Verified end users
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserIdentitiesResponse'
              examples:
                default:
                  $ref: '#/components/examples/UserIdentitiesResponseExample'
    post:
      operationId: CreateUserIdentity
      tags:
        - User Identities
      summary: Zendesk Post  Api V2 Users User_id Identities
      description: >
        Adds an identity to a user's profile. An agent can add an identity to
        any user profile.


        Supported identity types:


        | Type             | Example |

        | ---------------- | ------- |

        | email            | `{ "type" : "email", "value" :
        "[email protected]" }` |

        | twitter          | `{ "type" : "twitter", "value" : "screen_name" }` |

        | facebook         | `{ "type" : "facebook", "value" : "855769377321" }`
        |

        | google           | `{ "type" : "google", "value" : "[email protected]"
        }` |

        | agent_forwarding | `{ "type" : "agent_forwarding", "value" : "+1
        555-123-4567" }` |

        | phone_number     | `{ "type" : "phone_number", "value" : "+1
        555-123-4567" }` |


        To create an identity without sending out a verification email, include
        a `"skip_verify_email": true` property. The `"skip_verify_email": true`
        property does not apply when updating your own agent profile. A welcome
        or verification email will be sent regardless of this setting.


        #### Allowed For


        * Agents
      responses:
        '201':
          description: Created response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserIdentityResponse'
              examples:
                default:
                  $ref: '#/components/examples/UserIdentityCreateResponseExample'
  /api/v2/users/{user_id}/identities/{user_identity_id}:
    parameters:
      - $ref: '#/components/parameters/UserId'
      - $ref: '#/components/parameters/UserIdentityId'
    get:
      operationId: ShowUserIdentity
      tags:
        - User Identities
      summary: Zendesk Get  Api V2 Users User_id Identities User_identity_id
      description: >
        Shows the identity with the given id for a given user.


        Use the first endpoint if authenticating as an agent. Use the second if
        authenticating as an end user. End users can only view email or phone
        number identity.


        #### Allowed For


        * Agents

        * Verified end users
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserIdentityResponse'
              examples:
                default:
                  $ref: '#/components/examples/UserIdentityResponseExample'
    put:
      operationId: UpdateUserIdentity
      tags:
        - User Identities
      summary: Zendesk Put  Api V2 Users User_id Identities User_identity_id
      description: >
        This endpoint allows you to:


        * Set the specified identity as verified (by setting `verified` to
        "true" or `verification_method` to "low")

        * Unverify a verified identity (by setting `verified` to "false" or
        `verification_method` to "none")

        * Update the `value` property of the specified identity


        You can't change an identity's `primary` attribute with this endpoint.
        You must use the [Make Identity Primary](#make-identity-primary)
        endpoint instead.


        #### Allowed For


        * Agents
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserIdentityResponse'
              examples:
                default:
                  $ref: '#/components/examples/UserIdentityUpdateResponseExample'
    delete:
      operationId: DeleteUserIdentity
      tags:
        - User Identities
      summary: Zendesk Delete  Api V2 Users User_id Identities User_identity_id
      description: >
        Deletes the identity for a given user.

        In certain cases, a phone number associated with an identity is still
        visible on the user profile after the identity has been deleted via API.
        You can remove the phone number from the user profile by updating the
        `phone` attribute of the user to an empty string. See [Update User via
        API](/api-reference/ticketing/users/users/#update-user) for details and
        examples.


        Deleting identities with type `messaging` could break messaging
        functionality. For example, an agent may stop being able to send
        messages via the messaging channel.


        #### Allowed For

        * Agents
      responses:
        '204':
          description: No Content response
  /api/v2/users/{user_id}/identities/{user_identity_id}/make_primary:
    parameters:
      - $ref: '#/components/parameters/UserId'
      - $ref: '#/components/parameters/UserIdentityId'
    put:
      operationId: MakeUserIdentityPrimary
      tags:
        - User Identities
      summary: Zendesk Put  Api V2 Users User_id Identities User_identity_id Make_primary
      description: >
        Sets the specified identity as primary. To change other attributes, use
        the [Update  Identity](#update-identity) endpoint. This is a
        collection-level operation and the correct behavior for an API client is
        to subsequently reload the entire collection.


        The first endpoint is the preferred option if authenticating as an
        agent. If authenticating as an end user, you can only use the second
        endpoint. In addition, an end user can only make an email identity
        primary if the email is verified.


        #### Allowed For


        * Agents

        * Verified end users
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserIdentitiesResponse'
              examples:
                default:
                  $ref: '#/components/examples/UserIdentitiesResponseExample'
  /api/v2/users/{user_id}/identities/{user_identity_id}/request_verification:
    parameters:
      - $ref: '#/components/parameters/UserId'
      - $ref: '#/components/parameters/UserIdentityId'
    put:
      operationId: RequestUserVerfication
      tags:
        - User Identities
      summary: >-
        Zendesk Put  Api V2 Users User_id Identities User_identity_id Request_verification
      description: >
        Sends the user a verification email with a link to verify ownership of
        the email address.


        #### Allowed For


        * Agents
      responses:
        '200':
          description: Success description
          content:
            application/json:
              schema:
                type: string
                description: Empty response
                example: ''
              example: ''
  /api/v2/users/{user_id}/identities/{user_identity_id}/verify:
    parameters:
      - $ref: '#/components/parameters/UserId'
      - $ref: '#/components/parameters/UserIdentityId'
    put:
      operationId: VerifyUserIdentity
      tags:
        - User Identities
      summary: Zendesk Put  Api V2 Users User_id Identities User_identity_id Verify
      description: >
        Sets the specified identity as verified.


        For security reasons, you can't use this endpoint to update the email
        identity of the account owner. To verify the person's identity, send a
        verification email. See [Verifying the account owner's email
        address](https://support.zendesk.com/hc/en-us/articles/4408828975130) in
        Zendesk help.


        If [automatic mapping of users to organizations using the email
        domain](https://support.zendesk.com/hc/en-us/articles/4408882246298-Creating-organizations#topic_nxl_vdt_bc)
        is enabled and the user is not already a member of an organization, they
        will be automatically added to the organization associated with the
        email domain once the email identity is verified.


        #### Allowed For


        * Agents
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserIdentityResponse'
              examples:
                default:
                  $ref: '#/components/examples/UserIdentityResponseExample'
  /api/v2/users/{user_id}/merge:
    parameters:
      - $ref: '#/components/parameters/UserId'
    put:
      operationId: MergeEndUsers
      tags:
        - Users
      summary: Zendesk Put  Api V2 Users User_id Merge
      description: >
        Merges the end user specified in the path parameter into the existing
        end user specified in the request body.


        Any two end users can be merged with the exception of end users created
        by sharing agreements.


        To be eligible for merging, the user in the path parameter must be a
        requester on 10,000 or fewer tickets. Otherwise, the merge will be
        blocked.


        Agents, admins, and users with more than 10,000 requested tickets cannot
        be merged.


        For more information about how user data is merged, see [Merging a
        user's duplicate
        account](https://support.zendesk.com/hc/en-us/articles/4408887695898) in
        Zendesk help.


        #### Allowed For


        * Admins or agents with permission to edit end users
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserRequest'
            examples:
              default:
                $ref: '#/components/examples/MergeEndUsersRequestExample'
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserResponse'
              examples:
                default:
                  $ref: '#/components/examples/UserResponseExample'
  /api/v2/users/{user_id}/organization_memberships/{organization_membership_id}/make_default:
    parameters:
      - $ref: '#/components/parameters/UserId'
      - $ref: '#/components/parameters/OrganizationMembershipId'
    put:
      operationId: SetOrganizationMembershipAsDefault
      tags:
        - Organization Memberships
      summary: >-
        Zendesk Put  Api V2 Users User_id Organization_memberships Organization_membership_id Make_default
      description: >
        Sets the default organization membership of a given user.


        #### Allowed for


        * Admins

        * Agents when setting the default organization membership for an end
        user
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationMembershipsResponse'
              examples:
                default:
                  $ref: '#/components/examples/OrganizationMembershipsResponseExample'
  /api/v2/users/{user_id}/organizations/{organization_id}:
    parameters:
      - $ref: '#/components/parameters/OrganizationId'
      - $ref: '#/components/parameters/UserId'
    delete:
      operationId: UnassignOrganization
      tags:
        - Organization Memberships
      summary: Zendesk Delete  Api V2 Users User_id Organizations Organization_id
      description: >
        Immediately removes a user from an organization and schedules a job to
        unassign all working tickets currently assigned to the user and
        organization combination. The `organization_id` of the unassigned
        tickets is set to null.


        #### Allowed For


        * Agents
      responses:
        '204':
          description: No Content response
  /api/v2/users/{user_id}/organizations/{organization_id}/make_default:
    parameters:
      - $ref: '#/components/parameters/UserId'
      - $ref: '#/components/parameters/OrganizationId'
    put:
      operationId: SetOrganizationAsDefault
      tags:
        - Organization Memberships
      summary: Zendesk Put  Api V2 Users User_id Organizations Organization_id Make_default
      description: |
        Sets the default organization membership of a given user.

        #### Allowed For

        * Agents
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationMembershipResponse'
              examples:
                default:
                  $ref: '#/components/examples/OrganizationMembershipResponseExample'
  /api/v2/users/{user_id}/password:
    parameters:
      - $ref: '#/components/parameters/UserId'
    post:
      operationId: SetUserPassword
      tags:
        - User Passwords
      summary: Zendesk Post  Api V2 Users User_id Password
      description: >
        An admin can set a user's password only if the setting is enabled in
        Zendesk Support under **Settings** > **Security** > **Global**. The
        setting is off by default. Only the account owner can access and change
        this setting.


        #### Allowed For


        * Admins
      responses:
        '200':
          description: Success description
          content:
            application/json:
              schema:
                type: string
                description: Empty response
                example: ''
              example: ''
    put:
      operationId: ChangeOwnPassword
      tags:
        - User Passwords
      summary: Zendesk Put  Api V2 Users User_id Password
      description: >
        You can only change your own password. Nobody can change the password of
        another user because it requires knowing the user's existing password.
        However, an admin can set a new password for another user without
        knowing the existing password. See [Set a User's
        Password](#set-a-users-password) above.


        #### Allowed For


        * Agents

        * End Users
      responses:
        '200':
          description: Success description
          content:
            application/json:
              schema:
                type: string
                description: Empty response
                example: ''
              example: ''
  /api/v2/users/{user_id}/password/requirements:
    parameters:
      - $ref: '#/components/parameters/UserId'
    get:
      operationId: GetUserPasswordRequirements
      tags:
        - User Passwords
      summary: Zendesk Get  Api V2 Users User_id Password Requirements
      description: |
        #### Allowed For

        * Agents
        * End Users
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserPasswordRequirementsResponse'
              examples:
                default:
                  $ref: >-
                    #/components/examples/UserPasswordRequirementsResponseExample
  /api/v2/users/{user_id}/related:
    parameters:
      - $ref: '#/components/parameters/UserId'
    get:
      operationId: ShowUserRelated
      tags:
        - Users
      summary: Zendesk Get  Api V2 Users User_id Related
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserRelatedResponse'
              examples:
                default:
                  $ref: '#/components/examples/UserRelatedResponseExample'
  /api/v2/users/{user_id}/sessions:
    parameters:
      - $ref: '#/components/parameters/UserId'
    delete:
      operationId: BulkDeleteSessionsByUserId
      tags:
        - Sessions
      summary: Zendesk Delete  Api V2 Users User_id Sessions
      description: |
        Deletes all the sessions for a user.

        #### Allowed For

        * Admins, Agents, End users
      responses:
        '204':
          description: No Content
  /api/v2/users/{user_id}/sessions/{session_id}:
    parameters:
      - $ref: '#/components/parameters/SessionId'
      - $ref: '#/components/parameters/UserId'
    get:
      operationId: ShowSession
      tags:
        - Sessions
      summary: Zendesk Get  Api V2 Users User_id Sessions Session_id
      description: |
        #### Allowed For

        * Admins, Agents, End users
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SessionResponse'
              examples:
                default:
                  $ref: '#/components/examples/SessionResponseExample'
    delete:
      operationId: DeleteSession
      tags:
        - Sessions
      summary: Zendesk Delete  Api V2 Users User_id Sessions Session_id
      description: |
        #### Allowed For

        * Admins, Agents, End users
      responses:
        '204':
          description: No Content
  /api/v2/users/{user_id}/skips:
    parameters:
      - $ref: '#/components/parameters/SkipTicketUserId'
      - $ref: '#/components/parameters/TicketSortOrder'
      - $ref: '#/components/parameters/TicketId'
    get:
      operationId: ListTicketSkips
      tags:
        - Ticket Skips
      summary: Zendesk Get  Api V2 Users User_id Skips
      description: >
        Archived tickets are not included in the response. See

        [About archived
        tickets](https://support.zendesk.com/hc/en-us/articles/203657756) in

        the Support Help Center.


        #### Pagination


        - Cursor pagination (recommended)

        - Offset pagination


        See [Pagination](/api-reference/introduction/pagination/).


        Returns a maximum of 100 records per page.


        #### Allowed For

        * Agents with "View only" or higher reports permissions in Support.
          These permissions are distinct from Explore permissions.
        * Agents retrieving their own skips
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TicketSkipsResponse'
              examples:
                default:
                  $ref: '#/components/examples/TicketSkipResponseExample'
  /api/v2/users/autocomplete:
    get:
      operationId: AutocompleteUsers
      tags:
        - Users
      summary: Zendesk Get  Api V2 Users Autocomplete
      description: >
        Returns an array of users whose name starts with the value specified in
        the `name` parameter.

        It only returns users with no foreign identities.


        #### Allowed For


        * Agents
      parameters:
        - name: name
          in: query
          description: |
            The name to search for the user.
          required: true
          schema:
            type: string
          example: gil
        - $ref: >-
            #/components/parameters/LookupRelationshipAutocompleteFieldIdFragment
        - $ref: '#/components/parameters/LookupRelationshipAutocompleteSourceFragment'
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsersResponse'
              examples:
                default:
                  $ref: '#/components/examples/SearchUsersResponseExample'
  /api/v2/users/count:
    get:
      operationId: CountUsers
      tags:
        - Users
      summary: Zendesk Get  Api V2 Users Count
      description: >
        Returns an approximate count of users. If the count exceeds 100,000, it
        is updated every 24 hours.


        The response includes a `refreshed_at` property in a `count` object that
        contains a timestamp indicating when the count was last updated.


        **Note**: When the count exceeds 100,000, the `refreshed_at` property
        may occasionally be null.

        This indicates that the count is being updated in the background. The
        `count` object's `value` property is limited to 100,000 until the update
        is complete.


        #### Allowed For


        * Admins, Agents and Light Agents
      parameters:
        - $ref: '#/components/parameters/UserRoleFilter'
        - $ref: '#/components/parameters/UserRolesFilter'
        - $ref: '#/components/parameters/UserPermissionSetFilter'
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CountResponse'
              examples:
                default:
                  $ref: '#/components/examples/UserCountResponseExample'
  /api/v2/users/create_many:
    post:
      operationId: CreateManyUsers
      tags:
        - Users
      summary: Zendesk Post  Api V2 Users Create_many
      description: >
        Accepts an array of up to 100 user objects.


        **Note**: To protect the data in your Zendesk account, bulk us

# --- truncated at 32 KB (56 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/zendesk/refs/heads/main/openapi/users-openapi-original.yml
Zendesk Users API

Documentation

Specifications

Schemas & Data

Other Resources

OpenAPI Specification
