Zendesk

Zendesk User Fields API

The User Fields API from Zendesk — 5 operation(s) for user fields.

GitHub OpenAPI

Operations 10

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /api/v2/user_fields List custom user fields · Zendesk Get Api V2 User_fields #
Ask an LLM
“What custom fields exist on user profiles?”
“Are user fields returned in the order configured in Support?”
Tell an agent
List the custom user fields in my account.
Show every custom field on end-user profiles.
POST /api/v2/user_fields Create a custom user field · Zendesk Post Api V2 User_fields #
Ask an LLM
“Can I add a dropdown or date field to user profiles?”
“Which field types can a new user field be?”
Tell an agent
Create a text user field called Employee ID.
Add a dropdown user field for customer tier.
GET /api/v2/user_fields/{user_field_id} Get a custom user field · Zendesk Get Api V2 User_fields User_field_id #
Ask an LLM
“Where can I see the settings of one user field?”
“Can agents read a single user field's definition?”
Tell an agent
Show the details of this user field.
Get the configuration of the customer tier user field.
PUT /api/v2/user_fields/{user_field_id} Update a custom user field · Zendesk Put Api V2 User_fields User_field_id #
Ask an LLM
“Can I change the dropdown choices of a user field?”
“What happens to existing options if I send a new list for a user field?”
Tell an agent
Update the title of this user field.
Replace the dropdown options on the customer tier user field.
DELETE /api/v2/user_fields/{user_field_id} Delete a custom user field · Zendesk Delete Api V2 User_fields User_field_id #
Ask an LLM
“Can an admin remove a custom user field entirely?”
“Is deleting a user field restricted to admins?”
Tell an agent destructive · confirm first
Delete this custom user field.
Remove the unused Employee ID user field.
GET /api/v2/user_fields/{user_field_id}/options List options of a dropdown user field · Zendesk Get Api V2 User_fields User_field_id Options #
Ask an LLM
“What choices does a dropdown user field offer?”
“Can I page through the options of a user dropdown field?”
Tell an agent
List the options of this dropdown user field.
Show the choices available in the customer tier field.
POST /api/v2/user_fields/{user_field_id}/options Create or update a user field option · Zendesk Post Api V2 User_fields User_field_id Options #
Ask an LLM
“Can I add a new choice to a user dropdown field?”
“Does sending an option id update the existing choice instead of adding one?”
Tell an agent
Add a Platinum option to the customer tier user field.
Rename an existing option on this dropdown user field.
GET /api/v2/user_fields/{user_field_id}/options/{user_field_option_id} Get one option of a user field · Zendesk Get Api V2 User_fields User_field_id Options User_field_option_id #
Ask an LLM
“Can I look up a single choice in a user dropdown field?”
“What name and value does one user field option have?”
Tell an agent
Show this option of the user field.
Get the details of the Gold option on the tier field.
DELETE /api/v2/user_fields/{user_field_id}/options/{user_field_option_id} Delete an option from a user field · Zendesk Delete Api V2 User_fields User_field_id Options User_field_option_id #
Ask an LLM
“Can I remove one choice from a user dropdown field?”
“Who is allowed to delete a user field option?”
Tell an agent destructive · confirm first
Delete this option from the user field.
Remove the Bronze choice from the customer tier field.
PUT /api/v2/user_fields/reorder Reorder custom user fields · Zendesk Put Api V2 User_fields Reorder #
Ask an LLM
“Can I change the order user fields appear on profiles?”
“Is reordering user fields an admin-only action?”
Tell an agent
Reorder the user fields into this sequence.
Move the customer tier user field to the top.

Documentation

📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/introduction/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/targets/targets/
📖
Documentation
https://developer.zendesk.com/api-reference/sales-crm/resources/account/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/activity_stream/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/account-configuration/channel_framework/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/ticket-attachments/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/account-configuration/audit_logs/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/organizations/organizations/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/business-rules/automations/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/ticket-management/bookmarks/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/account-configuration/brand_agents/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/account-configuration/brands/
📖
Documentation
https://developer.zendesk.com/api-reference/live-chat/chat-api/chats/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_comments/
📖
Documentation
https://developer.zendesk.com/api-reference/custom-data/introduction/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/account-configuration/custom_roles/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/custom_ticket_statuses/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/users/users/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/business-rules/deletion_schedules/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/ticket-management/dynamic_content/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/email_notifications/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/groups/group_memberships/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/business-rules/group_sla_policies/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/groups/groups/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_import/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/ticket-management/incremental_exports/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/ticket-management/job_statuses/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/account-configuration/locales/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/business-rules/macros/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/oauth/oauth_tokens/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/organizations/organization_fields/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/organizations/organization_memberships/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/organizations/organization_subscriptions/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/account-configuration/push_notification_devices/
📖
Documentation
https://developer.zendesk.com/api-reference/agent-availability/omnichannel_routing_queues/omnichannel_routing_queues/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/account-configuration/support_addresses/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/lookup_relationships/lookup_relationships/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/ticket-requests/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/ticket-management/resource_collections/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/ticket-management/skill_based_routing/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/ticket-management/satisfaction_ratings/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/ticket-management/satisfaction_reasons/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/ticket-management/search/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/account-configuration/sessions/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/sharing_agreements/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_skips/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/business-rules/sla_policies/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/suspended_tickets/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/ticket-management/tags/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_audits/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_fields/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_form_statuses/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_forms/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_metrics/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/business-rules/triggers/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/business-rules/views/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/ticket-management/workspaces/

Specifications

⚙
OpenAPI
https://artifacts.apis.io/zendesk/openapi/zendesk-user-fields-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/zendesk/json-schema/zendesk-ticket-schema.json
📊
JSONSchema
https://artifacts.apis.io/zendesk/json-schema/zendesk-user-schema.json

Other Resources

🔗
JSONLD
https://artifacts.apis.io/zendesk/json-ld/zendesk-context.jsonld

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/zendesk:zendesk-user-fields-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

zendesk-user-fields-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: '1.0'
  title: Zendesk User Fields API
  description: Needs a description.
tags:
- name: User Fields
paths:
  /api/v2/user_fields:
    get:
      operationId: ListUserFields
      tags:
      - User Fields
      summary: Zendesk Get Api V2 User_fields
      description: 'Returns a list of custom user fields in your account. Fields are returned in the order that you specify in your user fields configuration in Zendesk Support. Clients should cache this resource for the duration of their API usage and map the key for each User Field to the values returned under the `user_fields` attribute on the User resource.


        #### Pagination


        * Cursor pagination (recommended)

        * Offset pagination


        See Pagination.


        Returns a maximum of 100 records per page.


        #### Allowed For


        * Agents'
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserFieldsResponse'
              examples:
                default:
                  $ref: '#/components/examples/UserFieldsResponseExample'
    post:
      operationId: CreateUserField
      tags:
      - User Fields
      summary: Zendesk Post Api V2 User_fields
      description: 'Creates any of the following custom field types:


        * text (default when no "type" is specified)

        * textarea

        * checkbox

        * date

        * integer

        * decimal

        * regexp

        * dropdown

        * lookup

        * multiselect


        See About custom field types in Zendesk help.


        #### Allowed For


        * Admins'
      responses:
        '201':
          description: Created response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserFieldResponse'
              examples:
                default:
                  $ref: '#/components/examples/UserFieldCreateResponseExample'
  /api/v2/user_fields/{user_field_id}:
    parameters:
    - $ref: '#/components/parameters/UserFieldId'
    get:
      operationId: ShowUserField
      tags:
      - User Fields
      summary: Zendesk Get Api V2 User_fields User_field_id
      description: '#### Allowed for


        * Agents'
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserFieldResponse'
              examples:
                default:
                  $ref: '#/components/examples/UserFieldResponseExample'
    put:
      operationId: UpdateUserField
      tags:
      - User Fields
      summary: Zendesk Put Api V2 User_fields User_field_id
      description: '#### Updating a Dropdown (Tagger) or Multiselect Field


        Dropdown and multiselect fields return an array of `custom_field_options` which specify the name, value, and order of the list of dropdown or multiselect options.

        Understand the following behavior when updating a dropdown or multiselect field:


        - All options must be passed on update. Options that are not passed will be removed. As a result, these values will be removed from any organizations.

        - To create a new option, pass a null `id` along with `name` and `value`.

        - To update an existing option, pass its `id` along with `name` and `value`.

        - To re-order an option, reposition it in the `custom_field_options` array relative to the other options.

        - To remove an option, omit it from the list of options upon update.


        #### Example Request


        ```bash

        curl https://{subdomain}.zendesk.com/api/v2/user_fields/{user_field_id}.json \

        -H "Content-Type: application/json" -X PUT \

        -d ''{"user_field": {"custom_field_options": [{"id": 124, "name": "Option 2", "value": "option_2"}, {"id": 123, "name": "Option 1", "value": "option_1"}, {"id": 125, "name": "Option 2", "value": "option_3"}]}}'' \

        -v -u {email_address}/token:{api_token}

        ```

        #### Allowed for


        * Admins'
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserFieldResponse'
              examples:
                default:
                  $ref: '#/components/examples/UserFieldUpdateResponseExample'
    delete:
      operationId: DeleteUserField
      tags:
      - User Fields
      summary: Zendesk Delete Api V2 User_fields User_field_id
      description: '#### Allowed for


        * Admins'
      responses:
        '204':
          description: No Content response
  /api/v2/user_fields/{user_field_id}/options:
    parameters:
    - $ref: '#/components/parameters/UserFieldId'
    get:
      operationId: ListUserFieldOptions
      tags:
      - User Fields
      summary: Zendesk Get Api V2 User_fields User_field_id Options
      description: 'Returns a list of custom user field options for the given dropdown user field.


        #### Pagination


        * Cursor pagination (recommended)

        * Offset pagination


        See Pagination.


        Returns a maximum of 100 records per page.


        #### Allowed For


        * Agents'
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomFieldOptionsResponse'
              examples:
                default:
                  $ref: '#/components/examples/CustomUserFieldOptionsResponseExample'
    post:
      operationId: CreateOrUpdateUserFieldOption
      tags:
      - User Fields
      summary: Zendesk Post Api V2 User_fields User_field_id Options
      description: 'Creates a new option or updates an existing option for the given drop-down user field.


        To update an option, include the id of the option in the `custom_field_option` object. Example: `{"custom_field_option": {"id": 10002, "name": "Pineapples", ... }`. If an option exists for the given ID, the option will be updated. Otherwise, a new option will be created.


        #### Response


        Returns one of the following status codes:


        - 200 with `Location: /api/v2/user_fields/{user_field_id}/options.json` if the user field option already exists in the database

        - 201 with `Location: /api/v2/user_fields/{user_field_id}/options.json` if the user field option is new


        #### Allowed For


        * Admins'
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomFieldOptionResponse'
              examples:
                default:
                  $ref: '#/components/examples/CustomUserFieldOptionUpdateResponseExample'
        '201':
          description: Created response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomFieldOptionResponse'
              examples:
                default:
                  $ref: '#/components/examples/CustomUserFieldOptionCreateResponseExample'
  /api/v2/user_fields/{user_field_id}/options/{user_field_option_id}:
    parameters:
    - $ref: '#/components/parameters/UserFieldId'
    - $ref: '#/components/parameters/UserFieldOptionId'
    get:
      operationId: ShowUserFieldOption
      tags:
      - User Fields
      summary: Zendesk Get Api V2 User_fields User_field_id Options User_field_option_id
      description: '#### Allowed for

        * Agents'
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomFieldOptionResponse'
              examples:
                default:
                  $ref: '#/components/examples/CustomUserFieldOptionResponseExample'
    delete:
      operationId: DeleteUserFieldOption
      tags:
      - User Fields
      summary: Zendesk Delete Api V2 User_fields User_field_id Options User_field_option_id
      description: '#### Allowed for

        * Admins'
      responses:
        '204':
          description: No Content response
  /api/v2/user_fields/reorder:
    put:
      operationId: ReorderUserField
      tags:
      - User Fields
      summary: Zendesk Put Api V2 User_fields Reorder
      description: '#### Allowed For


        * Admins'
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                type: string
                description: Empty response
                example: ''
              example: ''
components:
  schemas:
    CustomFieldOptionsResponse:
      type: object
      properties:
        count:
          type: integer
          description: Total count of records retrieved
          readOnly: true
        custom_field_options:
          type: array
          items:
            $ref: '#/components/schemas/CustomFieldOptionObject'
        next_page:
          type: string
          description: URL of the next page
          nullable: true
          readOnly: true
        previous_page:
          type: string
          description: URL of the previous page
          nullable: true
          readOnly: true
    UserFieldResponse:
      type: object
      properties:
        user_field:
          $ref: '#/components/schemas/UserFieldObject'
    CustomFieldOptionResponse:
      type: object
      properties:
        custom_field_option:
          $ref: '#/components/schemas/CustomFieldOptionObject'
    UserFieldsResponse:
      type: object
      properties:
        count:
          type: integer
          description: Total count of records retrieved
          readOnly: true
        next_page:
          type: string
          description: URL of the next page
          nullable: true
          readOnly: true
        previous_page:
          type: string
          description: URL of the previous page
          nullable: true
          readOnly: true
        user_fields:
          type: array
          items:
            $ref: '#/components/schemas/UserFieldObject'