CustomObject
{
"type": "object",
"required": [
"key",
"title",
"title_pluralized"
],
"properties": {
"key": {
"type": "string",
"readOnly": true,
"description": "A user-defined unique identifier. Writable on create only. Cannot be reused if deleted."
},
"url": {
"type": "string",
"readOnly": true,
"description": "Direct link to the specific custom object"
},
"title": {
"type": "string",
"description": "User-defined display name for the object"
},
"raw_title": {
"type": "string",
"description": "The dynamic content placeholder, if present, or the \"title\" value, if not. See [Dynamic Content Items](https://developer.zendesk.com)"
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "The time the object type was created"
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "The time of the last update of the object"
},
"description": {
"type": "string",
"description": "User-defined description of the object"
},
"raw_description": {
"type": "string",
"description": "The dynamic content placeholder, if present, or the \"raw_description\" value, if not. See [Dynamic Content Items](https://developer.zendesk.com)"
},
"title_pluralized": {
"type": "string",
"description": "User-defined pluralized version of the object's title"
},
"created_by_user_id": {
"type": "string",
"readOnly": true,
"description": "Id of a user who created the object"
},
"updated_by_user_id": {
"type": "string",
"readOnly": true,
"description": "Id of the last user who updated the object"
},
"raw_title_pluralized": {
"type": "string",
"description": "The dynamic content placeholder, if present, or the \"raw_title_pluralized\" value, if not. See [Dynamic Content Items](https://developer.zendesk.com)"
}
}
}
CustomObjectCreateInput
{
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Unique identifier. Writable on create only"
},
"title": {
"type": "string",
"description": "Display name for the object"
},
"title_pluralized": {
"type": "string",
"description": "Pluralized version of the object's title"
}
}
}
CustomObjectFieldResponse
{
"type": "object",
"properties": {
"custom_object_field": {
"$ref": "#/components/schemas/CustomFieldObject"
}
}
}
CustomObjectFieldsCreateRequest
{
"type": "object",
"properties": {
"custom_object_field": {
"$ref": "#/components/schemas/CustomFieldObject"
}
}
}
CustomObjectFieldsReorderFieldsResponse
{
"type": "string",
"example": "",
"description": "Empty response"
}
CustomObjectFieldsResponse
{
"type": "object",
"properties": {
"custom_object_fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFieldObject"
}
}
}
}
CustomObjectLimitsResponse
{
"type": "object",
"properties": {
"count": {
"type": "integer",
"readOnly": true,
"description": "The current numnber of the requested resource"
},
"limit": {
"type": "integer",
"readOnly": true,
"description": "The maximum allowed number for the requested resource"
}
}
}
CustomObjectRecord
{
"type": "object",
"required": [
"name"
],
"properties": {
"id": {
"type": "string",
"readOnly": true,
"description": "Automatically assigned upon creation"
},
"url": {
"type": "string",
"readOnly": true,
"description": "Direct link to the specific custom object"
},
"name": {
"type": "string",
"readOnly": true,
"description": "User-defined display name for the object"
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "The time the object was created"
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "The time of the last update of the object"
},
"external_id": {
"type": "string",
"nullable": true,
"description": "An id you can use to link custom object records to external data"
},
"custom_object_key": {
"type": "string",
"readOnly": true,
"description": "A user-defined unique identifier"
},
"created_by_user_id": {
"type": "string",
"readOnly": true,
"description": "Id of a user who created the object"
},
"updated_by_user_id": {
"type": "string",
"readOnly": true,
"description": "Id of the last user who updated the object"
},
"custom_object_fields": {
"type": "object",
"additionalProperties": true
}
}
}
CustomObjectRecordResponse
{
"type": "object",
"properties": {
"custom_object_record": {
"$ref": "#/components/schemas/CustomObjectRecord"
}
}
}
CustomObjectRecordsBulkCreateRequest
{
"type": "object",
"properties": {
"job": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomObjectRecord"
},
"description": "An array of record objects for job actions that create, update, or set. An array of strings for job actions that delete."
},
"action": {
"type": "string"
}
}
}
}
}
CustomObjectRecordsCreateRequest
{
"type": "object",
"properties": {
"custom_object_record": {
"$ref": "#/components/schemas/CustomObjectRecord"
}
}
}
CustomObjectRecordsGetCountResponse
{
"type": "object",
"properties": {
"count": {
"type": "object",
"additionalProperties": {
"properties": {
"value": {
"type": "integer",
"readOnly": true,
"description": "Number of records at the time of the latest count operation"
},
"refreshed_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "The time the last count was performed"
}
}
}
}
}
}
CustomObjectRecordsJobsResponse
{
"type": "object",
"properties": {
"job_status": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"url": {
"type": "string"
},
"total": {
"type": "integer"
},
"status": {
"type": "string"
},
"message": {
"type": "string",
"nullable": true
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomObjectRecord"
},
"nullable": true
},
"progress": {
"type": "integer",
"nullable": true
}
}
}
}
}
CustomObjectRecordsResponse
{
"type": "object",
"properties": {
"meta": {
"type": "object",
"required": [
"has_more",
"after_cursor",
"before_cursor"
],
"properties": {
"has_more": {
"type": "boolean"
},
"after_cursor": {
"type": "string",
"nullable": true
},
"before_cursor": {
"type": "string",
"nullable": true
}
}
},
"count": {
"type": "integer",
"readOnly": true,
"description": "The number of results returned for the current request"
},
"links": {
"type": "object",
"required": [
"prev",
"next"
],
"properties": {
"next": {
"type": "string",
"nullable": true
},
"prev": {
"type": "string",
"nullable": true
}
}
},
"custom_object_records": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomObjectRecord"
}
}
}
}
CustomObjectRecordsUpsertRequest
{
"type": "object",
"properties": {
"custom_object_record": {
"$ref": "#/components/schemas/CustomObjectRecord"
}
}
}
CustomObjectResponse
{
"type": "object",
"properties": {
"custom_object": {
"$ref": "#/components/schemas/CustomObject"
}
}
}
CustomObjectsCreateRequest
{
"type": "object",
"properties": {
"custom_object": {
"$ref": "#/components/schemas/CustomObjectCreateInput"
}
}
}
CustomObjectsResponse
{
"type": "object",
"properties": {
"custom_objects": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomObject"
}
}
}
}
CustomRoleConfigurationObject
{
"type": "object",
"properties": {
"chat_access": {
"type": "boolean",
"readOnly": true,
"description": "Whether or not the agent has access to Chat"
},
"light_agent": {
"type": "boolean",
"readOnly": true
},
"view_access": {
"type": "string",
"description": "What the agent can do with views. Allowed values: \"full\", \"manage-group\", \"manage-personal\", \"playonly\", \"readonly\""
},
"forum_access": {
"type": "string",
"description": "The kind of access the agent has to Guide. Allowed values: \"edit-topics\", \"full\", \"readonly\""
},
"group_access": {
"type": "boolean",
"readOnly": true,
"description": "Whether or not the agent can add or modify groups"
},
"macro_access": {
"type": "string",
"description": "What the agent can do with macros. Allowed values: \"full\", \"manage-group\", \"manage-personal\", \"readonly\""
},
"ticket_merge": {
"type": "boolean",
"description": "Whether or not the agent can merge tickets"
},
"voice_access": {
"type": "boolean",
"description": "Whether or not the agent can answer and place calls to end users"
},
"report_access": {
"type": "string",
"description": "What the agent can do with reports. Allowed values: \"full\", \"none\", \"readonly\""
},
"ticket_access": {
"type": "string",
"description": "What kind of tickets the agent can access. Allowed values: \"all\", \"assigned-only\", \"within-groups\", \"within-groups-and-public-groups\", \"within-organization\""
},
"explore_access": {
"type": "string",
"description": "Allowed values: \"edit\", \"full\", \"none\", \"readonly\""
},
"ticket_editing": {
"type": "boolean",
"description": "Whether or not the agent can edit ticket properties"
},
"manage_facebook": {
"type": "boolean",
"description": "Whether or not the agent can manage Facebook pages"
},
"moderate_forums": {
"type": "boolean",
"readOnly": true
},
"ticket_deletion": {
"type": "boolean",
"description": "Whether or not the agent can delete tickets"
},
"user_view_access": {
"type": "string",
"description": "What the agent can do with customer lists. Allowed values: \"full\", \"manage-group\", \"manage-personal\", \"none\", \"readonly\""
},
"manage_user_fields": {
"type": "boolean",
"description": "Whether or not the agent can create and manage user fields"
},
"ticket_tag_editing": {
"type": "boolean",
"description": "Whether or not the agent can edit ticket tags"
},
"manage_ticket_forms": {
"type": "boolean",
"description": "Whether or not the agent can create and manage ticket forms"
},
"end_user_list_access": {
"type": "string",
"description": "Whether or not the agent can view lists of user profiles. Allowed values: \"full\", \"none\""
},
"manage_ticket_fields": {
"type": "boolean",
"description": "Whether or not the agent can create and manage ticket fields"
},
"organization_editing": {
"type": "boolean",
"description": "Whether or not the agent can add or modify organizations"
},
"view_deleted_tickets": {
"type": "boolean",
"description": "Whether or not the agent can view deleted tickets"
},
"manage_business_rules": {
"type": "boolean",
"description": "Whether or not the agent can manage business rules"
},
"ticket_comment_access": {
"type": "string",
"description": "What type of comments the agent can make. Allowed values: \"public\", \"none\""
},
"twitter_search_access": {
"type": "boolean"
},
"manage_dynamic_content": {
"type": "boolean",
"description": "Whether or not the agent can access dynamic content"
},
"voice_dashboard_access": {
"type": "boolean",
"description": "Whether or not the agent can view details about calls on the Talk dashboard"
},
"end_user_profile_access": {
"type": "string",
"description": "What the agent can do with end-user profiles. Allowed values: \"edit\", \"edit-within-org\", \"full\", \"readonly\""
},
"side_conversation_create": {
"type": "boolean",
"description": "Whether or not the agent can contribute to side conversations"
},
"manage_organization_fields": {
"type": "boolean",
"description": "Whether or not the agent can create and manage organization fields"
},
"organization_notes_editing": {
"type": "boolean",
"readOnly": true,
"description": "Whether or not the agent can add or modify organization notes"
},
"assign_tickets_to_any_group": {
"type": "boolean",
"readOnly": true,
"description": "Whether or not the agent can assign tickets to any group"
},
"manage_contextual_workspaces": {
"type": "boolean",
"description": "Whether or not the agent can view, add, and edit contextual workspaces"
},
"manage_extensions_and_channels": {
"type": "boolean",
"description": "Whether or not the agent can manage channels and extensions"
},
"forum_access_restricted_content": {
"type": "boolean"
}
},
"description": "Configuration settings for the role. See [Configuration](https://developer.zendesk.com)"
}
CustomRoleObject
{
"type": "object",
"title": "Custom Agent Roles",
"required": [
"name",
"role_type"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true,
"description": "Automatically assigned on creation"
},
"name": {
"type": "string",
"description": "Name of the custom role"
},
"role_type": {
"type": "integer",
"readOnly": true,
"description": "The user's role. 0 stands for a custom agent, 1 for a light agent, 2 for a chat agent, 3 for a contributor, 4 for an admin and 5 for a billing admin. See [Understanding standard agent roles in Zendesk Support](https://support.zendesk.com/hc/en-us/articles/4409155971354-Understanding-standard-agent-roles-in-Zendesk-Support) in Zendesk help"
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "The time the record was created"
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "The time the record was last updated"
},
"description": {
"type": "string",
"description": "A description of the role"
},
"configuration": {
"$ref": "#/components/schemas/CustomRoleConfigurationObject"
},
"team_member_count": {
"type": "integer",
"readOnly": true,
"description": "The number of team members assigned to this role"
}
}
}
CustomRoleResponse
{
"type": "object",
"properties": {
"custom_role": {
"$ref": "#/components/schemas/CustomRoleObject"
}
}
}
CustomRolesResponse
{
"type": "object",
"properties": {
"custom_roles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomRoleObject"
}
}
}
}
CustomStatusCreateInput
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/CustomStatusUpdateInput"
},
{
"type": "object",
"properties": {
"status_category": {
"enum": [
"new",
"open",
"pending",
"hold",
"solved"
],
"type": "string",
"description": "The status category the custom ticket status belongs to"
}
}
}
]
}
CustomStatusCreateRequest
{
"type": "object",
"properties": {
"custom_status": {
"$ref": "#/components/schemas/CustomStatusCreateInput"
}
}
}
CustomStatusObject
{
"type": "object",
"required": [
"status_category",
"agent_label"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true,
"description": "Automatically assigned when the custom ticket status is created"
},
"active": {
"type": "boolean",
"description": "If true, the custom status is set to active, If false, the custom status is set to inactive"
},
"default": {
"type": "boolean",
"description": "If true, the custom status is set to default. If false, the custom status is set to non-default"
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "The date and time the custom ticket status was created"
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "The date and time the custom ticket status was last updated"
},
"agent_label": {
"type": "string",
"description": "The label displayed to agents. Maximum length is 48 characters"
},
"description": {
"type": "string",
"description": "The description of when the user should select this custom ticket status"
},
"end_user_label": {
"type": "string",
"description": "The label displayed to end users. Maximum length is 48 characters"
},
"raw_agent_label": {
"type": "string",
"readOnly": true,
"description": "The dynamic content placeholder. If the dynamic content placeholder is not available, this is the \"agent_label\" value. See [Dynamic Content Items](https://developer.zendesk.com)"
},
"raw_description": {
"type": "string",
"readOnly": true,
"description": "The dynamic content placeholder. If the dynamic content placeholder is not available, this is the \"description\" value. [Dynamic Content Items](https://developer.zendesk.com)"
},
"status_category": {
"enum": [
"new",
"open",
"pending",
"hold",
"solved"
],
"type": "string",
"description": "The status category the custom ticket status belongs to"
},
"raw_end_user_label": {
"type": "string",
"readOnly": true,
"description": "The dynamic content placeholder. If the dynamic content placeholder is not available, this is the \"end_user_label\" value. See [Dynamic Content Items](https://developer.zendesk.com)"
},
"end_user_description": {
"type": "string",
"description": "The description displayed to end users"
},
"raw_end_user_description": {
"type": "string",
"readOnly": true,
"description": "The dynamic content placeholder. If the dynamic content placeholder is not available, this is the \"end_user_description\" value. See [Dynamic Content Items](https://developer.zendesk.com)"
}
}
}
CustomStatusResponse
{
"type": "object",
"properties": {
"custom_status": {
"$ref": "#/components/schemas/CustomStatusObject"
}
}
}
CustomStatusUpdateInput
{
"type": "object",
"properties": {
"active": {
"type": "boolean",
"description": "True if the custom status is set as active; inactive if false"
},
"agent_label": {
"type": "string",
"description": "The dynamic content placeholder, if present, or the \"agent_label\" value, if not. See [Dynamic Content Items](https://developer.zendesk.com)"
},
"description": {
"type": "string",
"description": "The dynamic content placeholder, if present, or the \"description\" value, if not. See [Dynamic Content Items](https://developer.zendesk.com)"
},
"end_user_label": {
"type": "string",
"description": "The dynamic content placeholder, if present, or the \"end_user_label\" value, if not. See [Dynamic Content Items](https://developer.zendesk.com)"
},
"end_user_description": {
"type": "string",
"description": "The dynamic content placeholder, if present, or the \"end_user_description\" value, if not. See [Dynamic Content Items](https://developer.zendesk.com)"
}
}
}
CustomStatusUpdateRequest
{
"type": "object",
"properties": {
"custom_status": {
"$ref": "#/components/schemas/CustomStatusUpdateInput"
}
}
}
CustomStatusesResponse
{
"type": "object",
"properties": {
"custom_statuses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomStatusObject"
}
}
}
}
CustomTicketStatusesBulkUpdateDefaultResponse
{
"type": "object",
"example": {},
"properties": {}
}
DefinitionsResponse
{
"type": "object",
"properties": {
"definitions": {
"type": "object",
"properties": {
"conditions_all": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"group": {
"type": "string"
},
"title": {
"type": "string"
},
"values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"value": {
"type": "string"
},
"enabled": {
"type": "boolean"
}
}
}
},
"subject": {
"type": "string"
},
"nullable": {
"type": "boolean"
},
"operators": {
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"value": {
"type": "string"
},
"terminal": {
"type": "boolean"
}
}
}
},
"repeatable": {
"type": "boolean"
}
}
}
},
"conditions_any": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"group": {
"type": "string"
},
"title": {
"type": "string"
},
"values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"value": {
"type": "string"
},
"enabled": {
"type": "boolean"
}
}
}
},
"subject": {
"type": "string"
},
"nullable": {
"type": "boolean"
},
"operators": {
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"value": {
"type": "string"
},
"terminal": {
"type": "boolean"
}
}
}
},
"repeatable": {
"type": "boolean"
}
}
}
}
}
}
}
}
DeletedUserObject
{
"type": "object",
"required": [
"id",
"url",
"name",
"email",
"created_at",
"updated_at",
"time_zone",
"phone",
"shared_phone_number",
"photo",
"locale_id",
"locale",
"organization_id",
"role",
"active"
],
"properties": {
"id": {
"type": "integer"
},
"url": {
"type": "string"
},
"name": {
"type": "string"
},
"role": {
"type": "string"
},
"email": {
"type": "string"
},
"phone": {
"type": "string",
"nullable": true
},
"photo": {
"type": "object",
"nullable": true
},
"active": {
"type": "boolean"
},
"locale": {
"type": "string"
},
"locale_id": {
"type": "integer"
},
"time_zone": {
"type": "string"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"organization_id": {
"type": "integer"
},
"shared_phone_number": {
"type": "string",
"nullable": true
}
}
}
DeletedUserResponse
{
"type": "object",
"properties": {
"deleted_user": {
"$ref": "#/components/schemas/DeletedUserObject"
}
}
}
DeletedUsersResponse
{
"type": "object",
"properties": {
"deleted_users": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeletedUserObject"
}
}
}
}
DynamicContentObject
{
"type": "object",
"title": "Dynamic Content Items",
"required": [
"name",
"default_locale_id",
"variants"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true,
"description": "Automatically assigned when creating items"
},
"url": {
"type": "string",
"readOnly": true,
"description": "The API url of this item"
},
"name": {
"type": "string",
"description": "The unique name of the item"
},
"outdated": {
"type": "boolean",
"readOnly": true,
"description": "Indicates the item has outdated variants within it"
},
"variants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DynamicContentVariantObject"
},
"description": "All variants within this item. See [Dynamic Content Item Variants](https://developer.zendesk.com)"
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When this record was created"
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When this record was last updated"
},
"placeholder": {
"type": "string",
"readOnly": true,
"description": "Automatically generated placeholder for the item, derived from name"
},
"default_locale_id": {
"type": "integer",
"description": "The default locale for the item. Must be one of the [locales the account has active](/api-reference/ticketing/account-configuration/locales/#list-locales)."
}
}
}
DynamicContentResponse
{
"type": "object",
"properties": {
"item": {
"$ref": "#/components/schemas/DynamicContentObject"
}
}
}
DynamicContentVariantObject
{
"type": "object",
"example": {
"id": 23,
"url": "https://subdomain.zendesk.com/api/v2/dynamic_content/items/3/variants/23.json",
"active": true,
"content": "This is my dynamic content in English",
"default": true,
"outdated": false,
"locale_id": 125,
"created_at": "2014-04-09T19:53:23Z",
"updated_at": "2014-04-09T19:53:23Z"
},
"required": [
"content",
"locale_id"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true,
"description": "Automatically assigned when the variant is created"
},
"url": {
"type": "string",
"readOnly": true,
"description": "The API url of the variant"
},
"active": {
"type": "boolean",
"description": "If the variant is active and useable"
},
"content": {
"type": "string",
"description": "The content of the variant"
},
"default": {
"type": "boolean",
"description": "If the variant is the default for the item it belongs to"
},
"outdated": {
"type": "boolean",
"readOnly": true,
"description": "If the variant is outdated"
},
"locale_id": {
"type": "integer",
"description": "An active locale"
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the variant was created"
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When the variant was last updated"
}
}
}
DynamicContentVariantResponse
{
"type": "object",
"properties": {
"variant": {
"$ref": "#/components/schemas/DynamicContentVariantObject"
}
}
}
DynamicContentVariantsResponse
{
"type": "object",
"properties": {
"variants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DynamicContentVariantObject"
}
}
}
}
DynamicContentsResponse
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DynamicContentObject"
}
}
}
}
EmailCCObject
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/FollowerObject"
},
{
"type": "object",
"properties": {
"action": {
"enum": [
"put",
"delete"
],
"type": "string"
},
"user_id": {
"type": "string"
},
"user_name": {
"type": "string"
},
"user_email": {
"type": "string"
}
}
}
]
}
Error
{
"type": "object",
"required": [
"code",
"title"
],
"properties": {
"id": {
"type": "string"
},
"code": {
"type": "string"
},
"links": {
"type": "object"
},
"title": {
"type": "string"
},
"detail": {
"type": "string"
},
"source": {
"type": "object"
},
"status": {
"type": "string"
}
}
}
Errors
{
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Error"
}
}
}
}
EssentialsCardObject
{
"type": "object",
"example": {
"id": "123",
"key": "zen:custom_object:boat",
"fields": [
{
"id": null,
"zrn": "zen:user:identity:email"
},
{
"id": null,
"zrn": "zen:user:field:standard:external_id"
},
{
"id": null,
"zrn": "zen:user:field:standard:iana_time_zone"
},
{
"id": null,
"zrn": "zen:user:field:standard:locale"
},
{
"id": null,
"zrn": "zen:user:field:standard:organization_id"
}
],
"layout": "essentials_card",
"default": true,
"max_count": 20,
"created_at": "2012-04-02T22:55:29Z",
"updated_at": "2012-04-02T22:55:29Z"
},
"required": [
"fields"
],
"properties": {
"id": {
"type": "string",
"nullable": true,
"readOnly": true,
"description": "id of the essentials card\n"
},
"key": {
"type": "string",
"readOnly": true,
"description": "Object type. Example: `zen:user` refers to `User` type\n"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
},
"description": "Fields that are displayed in the essentials card details. The order is defined by the order of the fields in the array"
},
"layout": {
"type": "string",
"readOnly": true,
"description": "layout type\n"
},
"default": {
"type": "boolean",
"readOnly": true,
"description": "If true, the system has used the first twenty fields for the custom object type as the essentials card."
},
"max_count": {
"type": "integer",
"readOnly": true,
"description": "Maximum number of fields allowed in the essentials card"
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "Date and time the essentials card were created"
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "Date and time the essentials card were last updated"
}
}
}
EssentialsCardResponse
{
"type": "object",
"properties": {
"object_layout": {
"$ref": "#/components/schemas/EssentialsCardObject"
}
}
}
EssentialsCardsResponse
{
"type": "object",
"properties": {
"object_layouts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EssentialsCardObject"
}
}
}
}
ExportIncrementalOrganizationsResponse
{
"type": "object",
"example": {
"count": 1,
"end_time": 1601357503,
"next_page": "https://example.zendesk.com/api/v2/incremental/ticket_events.json?start_time=1601357503",
"end_of_stream": true,
"organizations": [
{
"id": 4112492,
"url": "https://example.zendesk.com/api/v2/organizations/4112492.json",
"name": "Groablet Enterprises",
"tags": [
"smiley",
"teapot_kettle"
],
"notes": "donkey",
"details": "caterpillar =)",
"group_id": 1835962,
"created_at": "2018-11-14T00:14:52Z",
"updated_at": "2018-11-14T00:54:22Z",
"external_id": "ABC198",
"domain_names": [
"remain.com"
],
"shared_tickets": false,
"shared_comments": false,
"organization_fields": {
"datepudding": "2018-11-04T00:00:00+00:00",
"org_field_1": "happy happy",
"org_field_2": "teapot_kettle"
}
}
]
},
"properties": {
"count": {
"type": "integer"
},
"end_time": {
"type": "integer"
},
"next_page": {
"type": "string",
"nullable": true
},
"end_of_stream": {
"type": "boolean"
},
"organizations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrganizationObject"
}
}
}
}
ExportIncrementalTicketEventsResponse
{
"type": "object",
"example": {
"count": 1,
"end_time": 1601357503,
"next_page": "https://example.zendesk.com/api/v2/incremental/ticket_events.json?start_time=1601357503",
"end_of_stream": true,
"ticket_events": [
{
"id": 926256957613,
"time": "2020-10-26T12:53:12Z",
"type": "measure",
"metric": "agent_work_time",
"ticket_id": 155,
"instance_id": 1
}
]
},
"properties": {
"count": {
"type": "integer"
},
"end_time": {
"type": "integer"
},
"next_page": {
"type": "string",
"nullable": true
},
"end_of_stream": {
"type": "boolean"
},
"ticket_events": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TicketMetricEventBaseObject"
}
}
}
}
FollowerObject
{
"type": "object",
"properties": {
"action": {
"enum": [
"put",
"delete"
],
"type": "string"
},
"user_id": {
"type": "string"
},
"user_email": {
"type": "string",
"format": "email"
}
}
}
GroupMembershipObject
{
"type": "object",
"required": [
"user_id",
"group_id"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true,
"description": "Automatically assigned upon creation"
},
"url": {
"type": "string",
"readOnly": true,
"description": "The API url of this record"
},
"default": {
"type": "boolean",
"description": "If true, tickets assigned directly to the agent will assume this membership's group"
},
"user_id": {
"type": "integer",
"description": "The id of an agent"
},
"group_id": {
"type": "integer",
"description": "The id of a group"
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "The time the group was created"
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "The time of the last update of the group"
}
}
}