Zendesk User Fields API is one of 150 APIs that Zendesk publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 2 JSON Schema definitions.
Tagged areas include User Fields. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 2 JSON Schemas.
This API exposes
10 operations
across 5 paths,
and defines 4 schemas.
It is described by OpenAPI 3.1.0, at version 1.0.
Requests are made against the base URL https://{subdomain}.zendesk.com.
10 operations5 paths4 schemas2 DELETE4 GET2 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
Specification
OpenAPI 3.1.0
API Version
1.0
Base URL
https://{subdomain}.zendesk.com
Resource Areas
1
Paths & Operations 10
Across 5 paths, the API surfaces 10 operations — 2 DELETE, 4 GET, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
User Fields 10
GET
/api/v2/user_fields
Zendesk Get Api V2 Userfields
ListUserFields→ 200
POST
/api/v2/user_fields
Zendesk Post Api V2 Userfields
CreateUserField→ 201
GET
/api/v2/user_fields/{user_field_id}
Zendesk Get Api V2 Userfields Userfieldid
ShowUserField1 param→ 200
PUT
/api/v2/user_fields/{user_field_id}
Zendesk Put Api V2 Userfields Userfieldid
UpdateUserField1 param→ 200
DELETE
/api/v2/user_fields/{user_field_id}
Zendesk Delete Api V2 Userfields Userfieldid
DeleteUserField1 param→ 204
GET
/api/v2/user_fields/{user_field_id}/options
Zendesk Get Api V2 Userfields Userfieldid Options
ListUserFieldOptions1 param→ 200
POST
/api/v2/user_fields/{user_field_id}/options
Zendesk Post Api V2 Userfields Userfieldid Options
Zendesk Delete Api V2 Userfields Userfieldid Options Userfieldoptionid
DeleteUserFieldOption2 params→ 204
PUT
/api/v2/user_fields/reorder
Zendesk Put Api V2 Userfields Reorder
ReorderUserField→ 200
Schemas 4
The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are UserFieldsResponse (4 properties), CustomFieldOptionsResponse (4 properties), UserFieldResponse (1 property), CustomFieldOptionResponse (1 property). Each schema is shown below with its type and property counts.
CustomFieldOptionsResponse
object
4 properties
UserFieldsResponse
object
4 properties
CustomFieldOptionResponse
object
1 property
UserFieldResponse
object
1 property
Specification
The full machine-readable OpenAPI contract behind this narrative.
