{
  "type": "object",
  "example": {
    "id": 498483,
    "url": "https://company.zendesk.com/api/v2/audit_logs/498483.json",
    "action": "update",
    "actor_id": 1234,
    "source_id": 3456,
    "actor_name": "Sameer Patel",
    "created_at": "2012-03-05T11:32:44Z",
    "ip_address": "209.119.38.228",
    "source_type": "user",
    "action_label": "Updated",
    "source_label": "John Doe",
    "change_description": "Role changed from Administrator to End User"
  },
  "properties": {
    "id": {
      "type": "integer",
      "readOnly": true,
      "description": "The id automatically assigned upon creation"
    },
    "url": {
      "type": "string",
      "readOnly": true,
      "description": "The URL to access the audit log"
    },
    "action": {
      "type": "string",
      "readOnly": true,
      "description": "Type of change made. Possible values are \"create\", \"destroy\", \"exported\", \"login\", and \"update\"\n"
    },
    "actor_id": {
      "type": "integer",
      "readOnly": true,
      "description": "id of the user or system that initiated the change"
    },
    "source_id": {
      "type": "integer",
      "readOnly": true,
      "description": "The id of the item being audited"
    },
    "actor_name": {
      "type": "string",
      "readOnly": true,
      "description": "Name of the user or system that initiated the change"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true,
      "description": "The time the audit got created"
    },
    "ip_address": {
      "type": "string",
      "readOnly": true,
      "description": "The IP address of the user doing the audit"
    },
    "source_type": {
      "type": "string",
      "readOnly": true,
      "description": "Item type being audited. Typically describes the system where the change\nwas initiated. Possible values vary based on your account's Zendesk\nproducts and activity. Common values include \"apitoken\", \"rule\", \"ticket\",\n\"user\", and \"zendesk/app_market/app\". The \"rule\" value is used for\n[automations](https://support.zendesk.com/hc/en-us/articles/4408832701850),\n[macros](https://support.zendesk.com/hc/en-us/articles/4408844187034),\n[triggers](https://support.zendesk.com/hc/en-us/articles/4408822236058),\n[views](https://support.zendesk.com/hc/en-us/articles/4408888828570),\nand other automated business rules\n"
    },
    "action_label": {
      "type": "string",
      "readOnly": true,
      "description": "Localized string of action field"
    },
    "source_label": {
      "type": "string",
      "readOnly": true,
      "description": "The name of the item being audited"
    },
    "change_description": {
      "type": "string",
      "readOnly": true,
      "description": "The description of the change that occurred"
    }
  }
}

{
  "type": "object",
  "properties": {
    "audit_log": {
      "$ref": "#/components/schemas/AuditLogObject"
    }
  }
}

{
  "type": "string",
  "example": "",
  "description": "Empty response"
}

{
  "type": "object",
  "properties": {
    "audit_logs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AuditLogObject"
      }
    }
  }
}

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "readOnly": true
    },
    "via": {
      "$ref": "#/components/schemas/ViaObject"
    },
    "events": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "readOnly": true
          },
          "body": {
            "type": "string",
            "readOnly": true
          },
          "type": {
            "type": "string",
            "readOnly": true
          },
          "value": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "integer"
              }
            ]
          },
          "field_name": {
            "type": "string",
            "readOnly": true
          }
        }
      },
      "readOnly": true
    },
    "metadata": {
      "type": "object",
      "readOnly": true
    },
    "author_id": {
      "type": "integer",
      "readOnly": true
    },
    "ticket_id": {
      "type": "integer",
      "readOnly": true
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    }
  }
}

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "readOnly": true,
      "description": "The author id"
    },
    "name": {
      "type": "string",
      "readOnly": true,
      "description": "The author name"
    },
    "email": {
      "type": "string",
      "readOnly": true,
      "description": "The author email"
    }
  }
}

{
  "type": "object",
  "example": {
    "id": 9873843,
    "title": "Roger Wilco",
    "active": true,
    "actions": [
      {
        "field": "priority",
        "value": "high"
      }
    ],
    "default": false,
    "position": 8,
    "raw_title": "Roger Wilco",
    "conditions": {
      "all": [
        {
          "field": "status",
          "value": "open",
          "operator": "is"
        },
        {
          "field": "priority",
          "value": "high",
          "operator": "less_than"
        }
      ],
      "any": []
    }
  },
  "properties": {
    "id": {
      "type": "integer",
      "readOnly": true,
      "description": "Automatically assigned when created"
    },
    "title": {
      "type": "string",
      "description": "The title of the automation"
    },
    "active": {
      "type": "boolean",
      "description": "Whether the automation is active"
    },
    "actions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ActionObject"
      },
      "description": "An object describing what the automation will do. See [Actions reference](https://developer.zendesk.com)"
    },
    "default": {
      "type": "boolean",
      "readOnly": true,
      "description": "If true, the automation is a default automation"
    },
    "position": {
      "type": "integer",
      "description": "The position of the automation which specifies the order it will be executed"
    },
    "raw_title": {
      "type": "string",
      "readOnly": true,
      "description": "The raw title of the automation"
    },
    "conditions": {
      "$ref": "#/components/schemas/ConditionsObject"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true,
      "description": "The time the automation was created"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true,
      "description": "The time of the last update of the automation"
    }
  }
}

{
  "type": "object",
  "properties": {
    "automation": {
      "$ref": "#/components/schemas/AutomationObject"
    }
  }
}

{
  "type": "object",
  "properties": {
    "count": {
      "type": "integer",
      "readOnly": true
    },
    "next_page": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    },
    "automations": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AutomationObject"
      }
    },
    "previous_page": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  }
}

{
  "type": "string",
  "example": "",
  "description": "Invalid attribute"
}

{
  "type": "string",
  "example": "",
  "description": "Invalid attribute"
}

{
  "type": "string",
  "example": "",
  "description": "empty"
}

{
  "type": "string",
  "example": "",
  "description": "Invalid attribute"
}

{
  "type": "string",
  "example": "",
  "description": "empty"
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/Error"
    },
    {
      "type": "object",
      "properties": {
        "trigger_id": {
          "type": "string"
        }
      }
    }
  ]
}

{
  "type": "object",
  "properties": {
    "job": {
      "type": "object",
      "properties": {
        "items": {
          "type": "object",
          "properties": {
            "triggers": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/TriggerBatchRequest"
              }
            },
            "trigger_categories": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/TriggerCategoryBatchRequest"
              }
            }
          }
        },
        "action": {
          "enum": [
            "patch"
          ],
          "type": "string"
        }
      }
    }
  }
}

{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/BatchErrorItem"
      }
    },
    "status": {
      "enum": [
        "complete",
        "failed"
      ],
      "type": "string"
    },
    "results": {
      "type": "object",
      "properties": {
        "triggers": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/TriggerObject"
          }
        },
        "trigger_categories": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/TriggerCategory"
          }
        }
      }
    }
  }
}

{
  "type": "object",
  "properties": {
    "bookmark": {
      "$ref": "#/components/schemas/BookmarkInput"
    }
  }
}

{
  "type": "object",
  "properties": {
    "ticket_id": {
      "type": "integer",
      "description": "The id of the ticket the bookmark is for."
    }
  }
}

{
  "type": "object",
  "title": "Bookmarks",
  "example": {
    "id": 35436,
    "url": "https://{subdomain}.zendesk.com/api/v2/bookmarks/35436.json",
    "ticket": {
      "id": 60,
      "subject": "Help, my printer is on fire!",
      "priority": "high",
      "description": "The fire is very colorful.",
      "requester_id": 156
    },
    "created_at": "2014-11-20T22:55:29Z"
  },
  "properties": {
    "id": {
      "type": "integer",
      "readOnly": true,
      "description": "Automatically assigned when the bookmark is created"
    },
    "url": {
      "type": "string",
      "readOnly": true,
      "description": "The API url of this bookmark"
    },
    "ticket": {
      "$ref": "#/components/schemas/TicketObject"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true,
      "description": "The time the bookmark was created"
    }
  },
  "x-konfig-properties": {
    "ticket": {
      "type": "object",
      "readOnly": true
    }
  }
}

{
  "type": "object",
  "properties": {
    "bookmark": {
      "$ref": "#/components/schemas/BookmarkObject"
    }
  }
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/OffsetPaginationObject"
    },
    {
      "type": "object",
      "properties": {
        "bookmarks": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/BookmarkObject"
          }
        }
      }
    }
  ],
  "title": "Bookmarks"
}

{
  "type": "object",
  "properties": {
    "brand": {
      "$ref": "#/components/schemas/BrandObject"
    }
  }
}

{
  "type": "object",
  "title": "Brands",
  "example": {
    "id": 47,
    "url": "https://company.zendesk.com/api/v2/brands/47.json",
    "logo": {
      "id": 928374,
      "url": "https://company.zendesk.com/api/v2/attachments/928374.json",
      "size": 166144,
      "file_name": "brand1_logo.png",
      "thumbnails": [
        {
          "id": 928375,
          "url": "https://company.zendesk.com/api/v2/attachments/928375.json",
          "size": 58298,
          "file_name": "brand1_logo_thumb.png",
          "content_url": "https://company.zendesk.com/photos/brand1_logo_thumb.png",
          "content_type": "image/png",
          "mapped_content_url": "https://company.com/photos/brand1_logo_thumb.png"
        },
        {
          "id": 928376,
          "url": "https://company.zendesk.com/api/v2/attachments/928376.json",
          "size": 58298,
          "file_name": "brand1_logo_small.png",
          "content_url": "https://company.zendesk.com/photos/brand1_logo_small.png",
          "content_type": "image/png",
          "mapped_content_url": "https://company.com/photos/brand1_logo_small.png"
        }
      ],
      "content_url": "https://company.zendesk.com/logos/brand1_logo.png",
      "content_type": "image/png"
    },
    "name": "Brand 1",
    "active": true,
    "default": true,
    "brand_url": "https://brand1.com",
    "subdomain": "brand1",
    "created_at": "2012-04-02T22:55:29Z",
    "updated_at": "2012-04-02T22:55:29Z",
    "host_mapping": "brand1.com",
    "has_help_center": true,
    "ticket_form_ids": [
      47,
      33,
      22
    ],
    "help_center_state": "enabled",
    "signature_template": "{{agent.signature}}"
  },
  "required": [
    "name",
    "subdomain"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "readOnly": true,
      "description": "The ID automatically assigned when the brand is created"
    },
    "url": {
      "type": "string",
      "readOnly": true,
      "description": "The API url of this brand"
    },
    "logo": {
      "$ref": "#/components/schemas/AttachmentObject"
    },
    "name": {
      "type": "string",
      "description": "The name of the brand"
    },
    "active": {
      "type": "boolean",
      "description": "If the brand is set as active"
    },
    "default": {
      "type": "boolean",
      "description": "Is the brand the default brand for this account"
    },
    "brand_url": {
      "type": "string",
      "description": "The url of the brand"
    },
    "subdomain": {
      "type": "string",
      "description": "The subdomain of the brand"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true,
      "description": "The time the brand was created"
    },
    "is_deleted": {
      "type": "boolean",
      "description": "If the brand object is deleted or not"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true,
      "description": "The time of the last update of the brand"
    },
    "host_mapping": {
      "type": "string",
      "description": "The hostmapping to this brand, if any. Only admins view this property."
    },
    "has_help_center": {
      "type": "boolean",
      "description": "If the brand has a Help Center"
    },
    "ticket_form_ids": {
      "type": "array",
      "items": {
        "type": "integer"
      },
      "readOnly": true,
      "description": "The ids of ticket forms that are available for use by a brand"
    },
    "help_center_state": {
      "enum": [
        "enabled",
        "disabled",
        "restricted"
      ],
      "type": "string",
      "readOnly": true,
      "description": "The state of the Help Center"
    },
    "signature_template": {
      "type": "string",
      "description": "The signature template for a brand"
    }
  }
}

{
  "type": "object",
  "properties": {
    "brand": {
      "$ref": "#/components/schemas/BrandObject"
    }
  }
}

{
  "type": "object",
  "properties": {
    "brand": {
      "$ref": "#/components/schemas/BrandObject"
    }
  }
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/OffsetPaginationObject"
    },
    {
      "type": "object",
      "properties": {
        "brands": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/BrandObject"
          },
          "description": "Array of brands"
        }
      }
    }
  ],
  "title": "Brands"
}

{
  "type": "object",
  "properties": {
    "ids": {
      "type": "string",
      "description": "The comma-separated list of custom ticket status ids to be set as default for their status categories"
    }
  }
}

{
  "type": "object"
}

{
  "type": "object",
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ChannelFrameworkResultObject"
      },
      "description": "An array of [result objects](https://developer.zendesk.com)"
    }
  }
}

{
  "type": "string",
  "example": "",
  "description": "Empty response"
}

{
  "type": "object",
  "properties": {
    "status": {
      "$ref": "#/components/schemas/ChannelFrameworkResultStatusObject"
    },
    "external_resource_id": {
      "type": "string",
      "readOnly": true,
      "description": "The external ID of the resource, as passed in"
    }
  }
}

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "readOnly": true,
      "description": "A code indicating the status of the import of the resource, as described in [status codes](https://developer.zendesk.com)"
    },
    "description": {
      "type": "string",
      "readOnly": true,
      "description": "In the case of an exception, a description of the exception. Otherwise, not present."
    }
  },
  "description": "The status of the import for the indicated resource"
}

{
  "type": "string",
  "example": "",
  "description": "Empty response"
}

{
  "type": "object",
  "example": {
    "name": "Someone Special",
    "email": "someone@example.com"
  },
  "properties": {
    "name": {
      "type": "string"
    },
    "email": {
      "type": "string",
      "format": "email"
    }
  }
}

{
  "type": "object",
  "required": [
    "action",
    "application",
    "account_subdomain",
    "executer_id",
    "user_id",
    "created_at"
  ],
  "properties": {
    "action": {
      "type": "string"
    },
    "user_id": {
      "type": "integer"
    },
    "created_at": {
      "type": "string"
    },
    "application": {
      "type": "string"
    },
    "executer_id": {
      "type": "integer",
      "nullable": true
    },
    "account_subdomain": {
      "type": "string"
    }
  }
}

{
  "type": "object",
  "properties": {
    "compliance_deletion_statuses": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ComplianceDeletionStatusObject"
      }
    }
  }
}

{
  "type": "object",
  "properties": {
    "field": {
      "type": "string",
      "description": "The name of a ticket field"
    },
    "value": {
      "type": "string",
      "description": "The value of a ticket field"
    },
    "operator": {
      "type": "string",
      "description": "A comparison operator"
    }
  }
}

{
  "type": "object",
  "properties": {
    "all": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ConditionObject"
      },
      "description": "Logical AND. Tickets must fulfill all of the conditions to be considered matching"
    },
    "any": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ConditionObject"
      },
      "description": "Logical OR. Tickets may satisfy any of the conditions to be considered matching"
    }
  },
  "description": "An object that describes the conditions under which the automation will execute. See [Conditions reference](https://developer.zendesk.com)"
}

{
  "type": "object",
  "properties": {
    "value": {
      "type": "integer",
      "readOnly": true
    },
    "refreshed_at": {
      "type": "string",
      "readOnly": true
    }
  }
}

{
  "type": "object",
  "properties": {
    "count": {
      "$ref": "#/components/schemas/CountOrganizationObject"
    }
  }
}

{
  "type": "object",
  "properties": {
    "count": {
      "type": "object",
      "properties": {
        "value": {
          "type": "integer"
        },
        "refreshed_at": {
          "type": "string",
          "format": "datetime"
        }
      }
    }
  }
}

{
  "type": "object",
  "required": [
    "id",
    "index"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "description": "the id of the new resource"
    },
    "index": {
      "type": "integer",
      "description": "the index number of the resul"
    }
  }
}

{
  "type": "object",
  "properties": {
    "user": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UserObject"
        },
        {
          "type": "object",
          "properties": {
            "authenticity_token": {
              "type": "string",
              "readOnly": true,
              "description": "CSRF token required by some Zendesk APIs."
            }
          }
        }
      ]
    }
  }
}

{
  "type": "object",
  "example": {
    "tickets": [
      {
        "id": 35436,
        "url": "https://company.zendesk.com/api/v2/tickets/35436.json",
        "via": {
          "channel": "web"
        },
        "tags": [
          "enterprise",
          "other_tag"
        ],
        "type": "incident",
        "due_at": null,
        "status": "open",
        "subject": "Help, my printer is on fire!",
        "group_id": 98738,
        "priority": "high",
        "recipient": "support@company.com",
        "created_at": "2009-07-20T22:55:29Z",
        "problem_id": 9873764,
        "updated_at": "2011-05-05T10:38:52Z",
        "assignee_id": 235323,
        "description": "The fire is very colorful.",
        "external_id": "ahg35h3jh",
        "raw_subject": "{{dc.printer_on_fire}}",
        "follower_ids": [
          35334,
          234
        ],
        "requester_id": 20978392,
        "submitter_id": 76872,
        "custom_fields": [
          {
            "id": 27642,
            "value": "745"
          },
          {
            "id": 27648,
            "value": "yes"
          }
        ],
        "has_incidents": false,
        "organization_id": 509974,
        "collaborator_ids": [
          35334,
          234
        ],
        "satisfaction_rating": {
          "id": 1234,
          "score": "good",
          "comment": "Great support!"
        },
        "sharing_agreement_ids": [
          84432
        ]
      }
    ],
    "after_url": "https://{subdomain}.zendesk.com/api/v2/incremental/tickets/cursor.json?cursor=MTU3NjYxMzUzOS4wfHw0Njd8",
    "before_url": null,
    "after_cursor": "MTU3NjYxMzUzOS4wfHw0Njd8",
    "before_cursor": null,
    "end_of_stream": true
  },
  "properties": {
    "tickets": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TicketObject"
      }
    },
    "after_url": {
      "type": "string",
      "nullable": true
    },
    "before_url": {
      "type": "string",
      "nullable": true
    },
    "after_cursor": {
      "type": "string",
      "nullable": true
    },
    "before_cursor": {
      "type": "string",
      "nullable": true
    },
    "end_of_stream": {
      "type": "boolean"
    }
  },
  "description": "See [Tickets](https://developer.zendesk.com) for a detailed example.\n"
}

{
  "type": "object",
  "example": {
    "users": [
      {
        "id": 35436,
        "url": "https://company.zendesk.com/api/v2/users/35436.json",
        "name": "Johnny Agent",
        "role": "agent",
        "tags": [
          "enterprise",
          "other_tag"
        ],
        "alias": "Mr. Johnny",
        "email": "johnny@example.com",
        "notes": "Johnny is a nice guy!",
        "phone": "+15551234567",
        "photo": {
          "id": 928374,
          "name": "my_funny_profile_pic.png",
          "size": 166144,
          "thumbnails": [
            {
              "id": 928375,
              "name": "my_funny_profile_pic_thumb.png",
              "size": 58298,
              "content_url": "https://company.zendesk.com/photos/my_funny_profile_pic_thumb.png",
              "content_type": "image/png"
            }
          ],
          "content_url": "https://company.zendesk.com/photos/my_funny_profile_pic.png",
          "content_type": "image/png"
        },
        "active": true,
        "locale": "en-US",
        "shared": false,
        "details": "",
        "verified": true,
        "locale_id": 1,
        "moderator": true,
        "role_type": 0,
        "signature": "Have a nice day, Johnny",
        "suspended": true,
        "time_zone": "Copenhagen",
        "created_at": "2009-07-20T22:55:29Z",
        "updated_at": "2011-05-05T10:38:52Z",
        "external_id": "sai989sur98w9",
        "user_fields": {
          "user_date": "2012-07-23T00:00:00Z",
          "user_decimal": 5.1,
          "user_dropdown": "option_1"
        },
        "shared_agent": false,
        "last_login_at": "2011-05-05T10:38:52Z",
        "custom_role_id": 9373643,
        "organization_id": 57542,
        "restricted_agent": true,
        "ticket_restriction": "assigned",
        "only_private_comments": false
      }
    ],
    "after_url": "https://example.zendesk.com/api/v2/incremental/users/cursor.json?cursor=MTU3NjYxMzUzOS4wfHw0Njd8",
    "before_url": null,
    "after_cursor": "MTU3NjYxMzUzOS4wfHw0Njd8",
    "before_cursor": null,
    "end_of_stream": true
  },
  "properties": {
    "users": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/UserObject"
      }
    },
    "after_url": {
      "type": "string",
      "nullable": true
    },
    "before_url": {
      "type": "string",
      "nullable": true
    },
    "after_cursor": {
      "type": "string",
      "nullable": true
    },
    "before_cursor": {
      "type": "string",
      "nullable": true
    },
    "end_of_stream": {
      "type": "boolean"
    }
  }
}

{
  "type": "object",
  "required": [
    "key",
    "type",
    "title"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "readOnly": true,
      "description": "Automatically assigned upon creation"
    },
    "key": {
      "type": "string",
      "description": "A unique key that identifies this custom field. This is used for updating the field and referencing in placeholders. The key must consist of only letters, numbers, and underscores. It can't be only numbers and can't be reused if deleted."
    },
    "tag": {
      "type": "string",
      "description": "Optional for custom field of type \"checkbox\"; not presented otherwise."
    },
    "url": {
      "type": "string",
      "readOnly": true,
      "description": "The URL for this resource"
    },
    "type": {
      "type": "string",
      "description": "The custom field type: \"checkbox\", \"date\", \"decimal\", \"dropdown\", \"integer\", [\"lookup\"](https://developer.zendesk.com), \"regexp\", \"text\", or \"textarea\""
    },
    "title": {
      "type": "string",
      "description": "The title of the custom field"
    },
    "active": {
      "type": "boolean",
      "description": "If true, this field is available for use"
    },
    "system": {
      "type": "boolean",
      "readOnly": true,
      "description": "If true, only active and position values of this field can be changed"
    },
    "position": {
      "type": "integer",
      "description": "Ordering of the field relative to other fields"
    },
    "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 of the last update of the ticket field"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true,
      "description": "The time of the last update of the ticket field"
    },
    "description": {
      "type": "string",
      "description": "User-defined description of this field's purpose"
    },
    "raw_description": {
      "type": "string",
      "description": "The dynamic content placeholder, if present, or the `description` value, if not. See [Dynamic Content Items](https://developer.zendesk.com)"
    },
    "relationship_filter": {
      "type": "object",
      "description": "A filter definition that allows your autocomplete to filter down results"
    },
    "custom_field_options": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CustomFieldOptionObject"
      },
      "description": "Required and presented for a custom field of type \"dropdown\". Each option is represented by an object with a `name` and `value` property"
    },
    "regexp_for_validation": {
      "type": "string",
      "nullable": true,
      "description": "Regular expression field only. The validation pattern for a field value to be deemed valid"
    },
    "relationship_target_type": {
      "type": "string",
      "description": "A representation of what type of object the field references. Options are \"zen:user\", \"zen:organization\", \"zen:ticket\", and \"zen:custom_object:{key}\" where key is a custom object key. For example \"zen:custom_object:apartment\"."
    }
  }
}

{
  "type": "object",
  "required": [
    "name",
    "value"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "readOnly": true,
      "description": "Automatically assigned upon creation"
    },
    "url": {
      "type": "string",
      "readOnly": true,
      "description": "URL of the dropdown option"
    },
    "name": {
      "type": "string",
      "description": "Name of the dropdown option"
    },
    "value": {
      "type": "string",
      "description": "Value of the dropdown option"
    },
    "position": {
      "type": "integer",
      "description": "Position of the dropdown option"
    },
    "raw_name": {
      "type": "string",
      "readOnly": true,
      "description": "Raw name of the dropdown option"
    }
  }
}

{
  "type": "object",
  "properties": {
    "custom_field_option": {
      "$ref": "#/components/schemas/CustomFieldOptionObject"
    }
  }
}

{
  "type": "object",
  "properties": {
    "count": {
      "type": "integer",
      "readOnly": true,
      "description": "Total count of records retrieved"
    },
    "next_page": {
      "type": "string",
      "nullable": true,
      "readOnly": true,
      "description": "URL of the next page"
    },
    "previous_page": {
      "type": "string",
      "nullable": true,
      "readOnly": true,
      "description": "URL of the previous page"
    },
    "custom_field_options": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CustomFieldOptionObject"
      }
    }
  }
}