Zendesk

{
  "type": "object",
  "properties": {
    "chat": {
      "type": "boolean"
    },
    "voice": {
      "type": "boolean"
    },
    "explore": {
      "type": "boolean"
    },
    "sandbox": {
      "type": "boolean"
    },
    "twitter": {
      "type": "boolean"
    },
    "facebook": {
      "type": "boolean"
    },
    "insights": {
      "type": "boolean"
    },
    "markdown": {
      "type": "boolean"
    },
    "allow_ccs": {
      "type": "boolean"
    },
    "is_abusive": {
      "type": "boolean"
    },
    "google_login": {
      "type": "boolean"
    },
    "light_agents": {
      "type": "boolean"
    },
    "ticket_forms": {
      "type": "boolean"
    },
    "user_tagging": {
      "type": "boolean"
    },
    "bcc_archiving": {
      "type": "boolean"
    },
    "twitter_login": {
      "type": "boolean"
    },
    "business_hours": {
      "type": "boolean"
    },
    "facebook_login": {
      "type": "boolean"
    },
    "on_hold_status": {
      "type": "boolean"
    },
    "ticket_tagging": {
      "type": "boolean"
    },
    "forum_analytics": {
      "type": "boolean"
    },
    "user_org_fields": {
      "type": "boolean"
    },
    "agent_forwarding": {
      "type": "boolean"
    },
    "csat_reason_code": {
      "type": "boolean"
    },
    "dynamic_contents": {
      "type": "boolean"
    },
    "topic_suggestion": {
      "type": "boolean"
    },
    "automatic_answers": {
      "type": "boolean"
    },
    "benchmark_opt_out": {
      "type": "boolean"
    },
    "fallback_composer": {
      "type": "boolean"
    },
    "advanced_analytics": {
      "type": "boolean"
    },
    "custom_dkim_domain": {
      "type": "boolean"
    },
    "chat_about_my_ticket": {
      "type": "boolean"
    },
    "customer_satisfaction": {
      "type": "boolean"
    },
    "good_data_and_explore": {
      "type": "boolean"
    },
    "rich_content_in_emails": {
      "type": "boolean"
    },
    "satisfaction_prediction": {
      "type": "boolean"
    },
    "customer_context_as_default": {
      "type": "boolean"
    },
    "explore_on_support_ent_plan": {
      "type": "boolean"
    },
    "explore_on_support_pro_plan": {
      "type": "boolean"
    },
    "organization_access_enabled": {
      "type": "boolean"
    },
    "suspended_ticket_notification": {
      "type": "boolean"
    },
    "allow_email_template_customization": {
      "type": "boolean"
    }
  },
  "description": "The active features for an account. See [Active Features](https://developer.zendesk.com)"
}

{
  "type": "object",
  "properties": {
    "agent_home": {
      "type": "boolean"
    },
    "focus_mode": {
      "type": "boolean"
    },
    "agent_workspace": {
      "type": "boolean"
    },
    "idle_timeout_enabled": {
      "type": "boolean"
    },
    "unified_agent_statuses": {
      "type": "boolean"
    },
    "aw_self_serve_migration_enabled": {
      "type": "boolean"
    }
  },
  "description": "Configuration for the agent workspace. See [Agents](https://developer.zendesk.com)"
}

{
  "type": "object",
  "properties": {
    "api_token_access": {
      "type": "string"
    },
    "api_password_access": {
      "type": "string"
    },
    "accepted_api_agreement": {
      "type": "boolean"
    }
  },
  "description": "API configuration options. See [API](https://developer.zendesk.com)"
}

{
  "type": "object",
  "properties": {
    "use": {
      "type": "boolean"
    },
    "create_public": {
      "type": "boolean"
    },
    "create_private": {
      "type": "boolean"
    }
  },
  "description": "Apps configuration options. See [Apps](https://developer.zendesk.com)"
}

{
  "type": "object",
  "properties": {
    "backend": {
      "type": "string"
    }
  },
  "description": "Billing configuration options. See [Billing](https://developer.zendesk.com)"
}

{
  "type": "object",
  "properties": {
    "text_color": {
      "type": "string"
    },
    "favicon_url": {
      "type": "string",
      "nullable": true
    },
    "header_color": {
      "type": "string"
    },
    "header_logo_url": {
      "type": "string",
      "nullable": true
    },
    "tab_background_color": {
      "type": "string"
    },
    "page_background_color": {
      "type": "string"
    }
  },
  "description": "Branding settings. See [Branding](https://developer.zendesk.com)"
}

{
  "type": "object",
  "properties": {
    "default_brand_id": {
      "type": "integer"
    },
    "require_brand_on_new_tickets": {
      "type": "boolean"
    }
  },
  "description": "Brand settings. See [Brands](https://developer.zendesk.com)"
}

{
  "type": "object",
  "properties": {
    "hosts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "url": {
            "type": "string"
          },
          "name": {
            "type": "string"
          }
        }
      }
    },
    "cdn_provider": {
      "type": "string"
    },
    "fallback_cdn_provider": {
      "type": "string"
    }
  },
  "description": "CDN settings"
}

{
  "type": "object",
  "properties": {
    "enabled": {
      "type": "boolean"
    },
    "available": {
      "type": "boolean"
    },
    "integrated": {
      "type": "boolean"
    },
    "welcome_message": {
      "type": "string"
    },
    "maximum_request_count": {
      "type": "integer"
    }
  },
  "description": "Zendesk Chat settings. See [Chat](https://developer.zendesk.com)"
}

{
  "type": "object",
  "properties": {
    "xsell_source": {
      "type": "string",
      "nullable": true
    },
    "show_chat_tooltip": {
      "type": "boolean"
    }
  },
  "description": "Cross Sell settings"
}

{
  "type": "object",
  "properties": {
    "enabled": {
      "type": "boolean"
    }
  },
  "description": "GoodData settings, used for insights. Legacy configuration prior to Zendesk Explore. See [GoodData Advanced Analytics](https://developer.zendesk.com)"
}

{
  "type": "object",
  "properties": {
    "has_google_apps": {
      "type": "boolean"
    },
    "has_google_apps_admin": {
      "type": "boolean"
    }
  },
  "description": "Google Apps configuration. See [G Suite](https://developer.zendesk.com)"
}

{
  "type": "object",
  "properties": {
    "check_group_name_uniqueness": {
      "type": "boolean"
    }
  },
  "description": "Group configuration"
}

{
  "type": "object",
  "properties": {
    "attachment_size": {
      "type": "integer"
    }
  },
  "description": "Account limits configuration. See [Limits](https://developer.zendesk.com)"
}

{
  "type": "object",
  "properties": {
    "locale_ids": {
      "type": "array",
      "items": {
        "type": "integer"
      }
    }
  },
  "description": "Internationalization configuration settings. See [Localization](https://developer.zendesk.com)"
}

{
  "type": "object",
  "properties": {
    "pod_id": {
      "type": "integer"
    },
    "reporting": {
      "type": "boolean"
    },
    "prefer_lotus": {
      "type": "boolean"
    }
  },
  "description": "Support UI settings. See [Lotus](https://developer.zendesk.com)"
}

{
  "type": "object",
  "properties": {
    "account_size": {
      "type": "string"
    }
  },
  "description": "Account metrics settings. See [Metrics](https://developer.zendesk.com)"
}

{
  "type": "object",
  "example": {
    "api": {
      "api_token_access": "true",
      "api_password_access": "true",
      "accepted_api_agreement": true
    },
    "cdn": {
      "hosts": [
        {
          "url": "https://p18.zdassets.com",
          "name": "default"
        },
        {
          "url": "https://d2y9oszrd3dhjh.cloudfront.net",
          "name": "cloudfront"
        }
      ],
      "cdn_provider": "default",
      "fallback_cdn_provider": "cloudfront"
    },
    "apps": {
      "use": true,
      "create_public": false,
      "create_private": true
    },
    "chat": {
      "enabled": false,
      "available": true,
      "integrated": true,
      "welcome_message": "Hi there. How can I help today?",
      "maximum_request_count": 1
    },
    "rule": {
      "macro_order": "alphabetical",
      "macro_most_used": true,
      "using_skill_based_routing": false,
      "skill_based_filtered_views": []
    },
    "user": {
      "tagging": true,
      "language_selection": true,
      "time_zone_selection": true,
      "have_gravatars_enabled": true,
      "multiple_organizations": false,
      "agent_created_welcome_emails": true,
      "end_user_phone_number_validation": false
    },
    "lotus": {
      "pod_id": 999,
      "reporting": true,
      "prefer_lotus": true
    },
    "voice": {
      "enabled": true,
      "logging": true,
      "outbound_enabled": true,
      "recordings_public": true,
      "maximum_queue_size": 5,
      "uk_mobile_forwarding": true,
      "maximum_queue_wait_time": 1,
      "agent_wrap_up_after_calls": true,
      "only_during_business_hours": false,
      "agent_confirmation_when_forwarding": true
    },
    "agents": {
      "agent_home": false,
      "focus_mode": false,
      "agent_workspace": false,
      "idle_timeout_enabled": false,
      "unified_agent_statuses": false,
      "aw_self_serve_migration_enabled": true
    },
    "brands": {
      "default_brand_id": 1873,
      "require_brand_on_new_tickets": false
    },
    "groups": {
      "check_group_name_uniqueness": true
    },
    "limits": {
      "attachment_size": 52428800
    },
    "billing": {
      "backend": "zuora"
    },
    "metrics": {
      "account_size": "100-399"
    },
    "routing": {
      "enabled": false,
      "autorouting_tag": "",
      "max_email_capacity": 0,
      "max_messaging_capacity": 0,
      "reassignment_talk_timeout": 30,
      "reassignment_messaging_enabled": true,
      "reassignment_messaging_timeout": 30
    },
    "tickets": {
      "tagging": true,
      "status_hold": false,
      "collaboration": true,
      "has_color_text": true,
      "agent_collision": true,
      "list_empty_views": true,
      "allow_group_reset": true,
      "email_attachments": false,
      "rich_text_comments": true,
      "chat_sla_enablement": false,
      "private_attachments": false,
      "emoji_autocompletion": true,
      "agent_ticket_deletion": false,
      "agent_invitation_enabled": true,
      "auto_translation_enabled": false,
      "markdown_ticket_comments": false,
      "assign_tickets_upon_solve": true,
      "using_skill_based_routing": false,
      "comments_public_by_default": true,
      "list_newest_comments_first": true,
      "assign_default_organization": true,
      "light_agent_email_ccs_allowed": false,
      "accepted_new_collaboration_tos": false,
      "maximum_personal_views_to_list": 8,
      "auto_updated_ccs_followers_rules": false,
      "is_first_comment_private_enabled": true,
      "follower_and_email_cc_collaborations": false
    },
    "twitter": {
      "shorten_url": "optional"
    },
    "branding": {
      "text_color": "FFFFFF",
      "favicon_url": null,
      "header_color": "78A300",
      "header_logo_url": null,
      "tab_background_color": "7FA239",
      "page_background_color": "333333"
    },
    "cross_sell": {
      "xsell_source": null,
      "show_chat_tooltip": true
    },
    "onboarding": {
      "product_sign_up": null,
      "onboarding_segments": null,
      "checklist_onboarding_version": 2
    },
    "statistics": {
      "forum": true,
      "search": true,
      "rule_usage": true
    },
    "google_apps": {
      "has_google_apps": false,
      "has_google_apps_admin": false
    },
    "ticket_form": {
      "ticket_forms_instructions": "Please choose your issue below",
      "raw_ticket_forms_instructions": "Please choose your issue below"
    },
    "localization": {
      "locale_ids": [
        1042
      ]
    },
    "active_features": {
      "chat": false,
      "voice": true,
      "explore": true,
      "sandbox": false,
      "twitter": true,
      "facebook": false,
      "insights": false,
      "markdown": false,
      "allow_ccs": true,
      "is_abusive": false,
      "google_login": false,
      "light_agents": false,
      "ticket_forms": true,
      "user_tagging": true,
      "bcc_archiving": false,
      "twitter_login": false,
      "business_hours": false,
      "facebook_login": false,
      "on_hold_status": false,
      "ticket_tagging": true,
      "forum_analytics": true,
      "user_org_fields": true,
      "agent_forwarding": false,
      "csat_reason_code": false,
      "dynamic_contents": false,
      "topic_suggestion": false,
      "automatic_answers": false,
      "benchmark_opt_out": false,
      "fallback_composer": false,
      "advanced_analytics": false,
      "custom_dkim_domain": true,
      "chat_about_my_ticket": false,
      "customer_satisfaction": false,
      "good_data_and_explore": false,
      "rich_content_in_emails": true,
      "satisfaction_prediction": false,
      "customer_context_as_default": false,
      "explore_on_support_ent_plan": false,
      "explore_on_support_pro_plan": false,
      "organization_access_enabled": true,
      "suspended_ticket_notification": false,
      "allow_email_template_customization": true
    },
    "side_conversations": {
      "email_channel": false,
      "slack_channel": false,
      "msteams_channel": false,
      "tickets_channel": false,
      "show_in_context_panel": false
    },
    "ticket_sharing_partners": {
      "support_addresses": [
        "support@grokpetre.zendesk.com"
      ]
    },
    "gooddata_advanced_analytics": {
      "enabled": true
    }
  },
  "properties": {
    "api": {
      "$ref": "#/components/schemas/AccountSettingsApiObject"
    },
    "cdn": {
      "$ref": "#/components/schemas/AccountSettingsCdnObject"
    },
    "apps": {
      "$ref": "#/components/schemas/AccountSettingsAppsObject"
    },
    "chat": {
      "$ref": "#/components/schemas/AccountSettingsChatObject"
    },
    "rule": {
      "$ref": "#/components/schemas/AccountSettingsRuleObject"
    },
    "user": {
      "$ref": "#/components/schemas/AccountSettingsUserObject"
    },
    "lotus": {
      "$ref": "#/components/schemas/AccountSettingsLotusObject"
    },
    "voice": {
      "$ref": "#/components/schemas/AccountSettingsVoiceObject"
    },
    "agents": {
      "$ref": "#/components/schemas/AccountSettingsAgentObject"
    },
    "brands": {
      "$ref": "#/components/schemas/AccountSettingsBrandsObject"
    },
    "groups": {
      "$ref": "#/components/schemas/AccountSettingsGroupObject"
    },
    "limits": {
      "$ref": "#/components/schemas/AccountSettingsLimitsObject"
    },
    "billing": {
      "$ref": "#/components/schemas/AccountSettingsBillingObject"
    },
    "metrics": {
      "$ref": "#/components/schemas/AccountSettingsMetricsObject"
    },
    "routing": {
      "$ref": "#/components/schemas/AccountSettingsRoutingObject"
    },
    "tickets": {
      "$ref": "#/components/schemas/AccountSettingsTicketObject"
    },
    "twitter": {
      "$ref": "#/components/schemas/AccountSettingsTwitterObject"
    },
    "branding": {
      "$ref": "#/components/schemas/AccountSettingsBrandingObject"
    },
    "cross_sell": {
      "$ref": "#/components/schemas/AccountSettingsCrossSellObject"
    },
    "onboarding": {
      "$ref": "#/components/schemas/AccountSettingsOnboardingObject"
    },
    "statistics": {
      "$ref": "#/components/schemas/AccountSettingsStatisticsObject"
    },
    "google_apps": {
      "$ref": "#/components/schemas/AccountSettingsGoogleAppsObject"
    },
    "ticket_form": {
      "$ref": "#/components/schemas/AccountSettingsTicketFormObject"
    },
    "localization": {
      "$ref": "#/components/schemas/AccountSettingsLocalizationObject"
    },
    "active_features": {
      "$ref": "#/components/schemas/AccountSettingsActiveFeaturesObject"
    },
    "side_conversations": {
      "$ref": "#/components/schemas/AccountSettingsSideConversationsObject"
    },
    "ticket_sharing_partners": {
      "$ref": "#/components/schemas/AccountSettingsTicketSharingPartnersObject"
    },
    "gooddata_advanced_analytics": {
      "$ref": "#/components/schemas/AccountSettingsGooddataAdvancedAnalyticsObject"
    }
  }
}

{
  "type": "object",
  "properties": {
    "product_sign_up": {
      "type": "string",
      "nullable": true
    },
    "onboarding_segments": {
      "type": "string",
      "nullable": true
    },
    "checklist_onboarding_version": {
      "type": "integer"
    }
  },
  "description": "Onboarding settings"
}

{
  "type": "object",
  "example": {
    "settings": {
      "api": {
        "api_token_access": "true",
        "api_password_access": "true",
        "accepted_api_agreement": true
      },
      "cdn": {
        "hosts": [
          {
            "url": "https://p18.zdassets.com",
            "name": "default"
          },
          {
            "url": "https://d2y9oszrd3dhjh.cloudfront.net",
            "name": "cloudfront"
          }
        ],
        "cdn_provider": "default",
        "fallback_cdn_provider": "cloudfront"
      },
      "apps": {
        "use": true,
        "create_public": false,
        "create_private": true
      },
      "chat": {
        "enabled": false,
        "available": true,
        "integrated": true,
        "welcome_message": "Hi there. How can I help today?",
        "maximum_request_count": 1
      },
      "rule": {
        "macro_order": "alphabetical",
        "macro_most_used": true,
        "using_skill_based_routing": false,
        "skill_based_filtered_views": []
      },
      "user": {
        "tagging": true,
        "language_selection": true,
        "time_zone_selection": true,
        "have_gravatars_enabled": true,
        "multiple_organizations": false,
        "agent_created_welcome_emails": true,
        "end_user_phone_number_validation": false
      },
      "lotus": {
        "pod_id": 999,
        "reporting": true,
        "prefer_lotus": true
      },
      "voice": {
        "enabled": true,
        "logging": true,
        "outbound_enabled": true,
        "recordings_public": true,
        "maximum_queue_size": 5,
        "uk_mobile_forwarding": true,
        "maximum_queue_wait_time": 1,
        "agent_wrap_up_after_calls": true,
        "only_during_business_hours": false,
        "agent_confirmation_when_forwarding": true
      },
      "agents": {
        "agent_home": false,
        "focus_mode": false,
        "agent_workspace": false,
        "idle_timeout_enabled": false,
        "unified_agent_statuses": false,
        "aw_self_serve_migration_enabled": true
      },
      "brands": {
        "default_brand_id": 1873,
        "require_brand_on_new_tickets": false
      },
      "groups": {
        "check_group_name_uniqueness": true
      },
      "limits": {
        "attachment_size": 52428800
      },
      "billing": {
        "backend": "zuora"
      },
      "metrics": {
        "account_size": "100-399"
      },
      "routing": {
        "enabled": false,
        "autorouting_tag": "",
        "max_email_capacity": 0,
        "max_messaging_capacity": 0
      },
      "tickets": {
        "tagging": true,
        "status_hold": false,
        "collaboration": true,
        "has_color_text": true,
        "agent_collision": true,
        "list_empty_views": true,
        "allow_group_reset": true,
        "email_attachments": false,
        "rich_text_comments": true,
        "chat_sla_enablement": false,
        "private_attachments": false,
        "emoji_autocompletion": true,
        "agent_ticket_deletion": false,
        "agent_invitation_enabled": true,
        "auto_translation_enabled": false,
        "markdown_ticket_comments": false,
        "assign_tickets_upon_solve": true,
        "using_skill_based_routing": false,
        "comments_public_by_default": true,
        "list_newest_comments_first": true,
        "assign_default_organization": true,
        "light_agent_email_ccs_allowed": false,
        "accepted_new_collaboration_tos": false,
        "maximum_personal_views_to_list": 8,
        "auto_updated_ccs_followers_rules": false,
        "is_first_comment_private_enabled": true,
        "follower_and_email_cc_collaborations": false
      },
      "twitter": {
        "shorten_url": "optional"
      },
      "branding": {
        "text_color": "FFFFFF",
        "favicon_url": null,
        "header_color": "78A300",
        "header_logo_url": null,
        "tab_background_color": "7FA239",
        "page_background_color": "333333"
      },
      "cross_sell": {
        "xsell_source": null,
        "show_chat_tooltip": true
      },
      "onboarding": {
        "product_sign_up": null,
        "onboarding_segments": null,
        "checklist_onboarding_version": 2
      },
      "statistics": {
        "forum": true,
        "search": true,
        "rule_usage": true
      },
      "google_apps": {
        "has_google_apps": false,
        "has_google_apps_admin": false
      },
      "ticket_form": {
        "ticket_forms_instructions": "Please choose your issue below",
        "raw_ticket_forms_instructions": "Please choose your issue below"
      },
      "localization": {
        "locale_ids": [
          1042
        ]
      },
      "active_features": {
        "chat": false,
        "voice": true,
        "explore": true,
        "sandbox": false,
        "twitter": true,
        "facebook": false,
        "insights": false,
        "markdown": false,
        "allow_ccs": true,
        "is_abusive": false,
        "google_login": false,
        "light_agents": false,
        "ticket_forms": true,
        "user_tagging": true,
        "bcc_archiving": false,
        "twitter_login": false,
        "business_hours": false,
        "facebook_login": false,
        "on_hold_status": false,
        "ticket_tagging": true,
        "forum_analytics": true,
        "user_org_fields": true,
        "agent_forwarding": false,
        "csat_reason_code": false,
        "dynamic_contents": false,
        "topic_suggestion": false,
        "automatic_answers": false,
        "benchmark_opt_out": false,
        "fallback_composer": false,
        "advanced_analytics": false,
        "custom_dkim_domain": true,
        "chat_about_my_ticket": false,
        "customer_satisfaction": false,
        "good_data_and_explore": false,
        "rich_content_in_emails": true,
        "satisfaction_prediction": false,
        "customer_context_as_default": false,
        "explore_on_support_ent_plan": false,
        "explore_on_support_pro_plan": false,
        "organization_access_enabled": true,
        "suspended_ticket_notification": false,
        "allow_email_template_customization": true
      },
      "side_conversations": {
        "email_channel": false,
        "slack_channel": false,
        "msteams_channel": false,
        "tickets_channel": false,
        "show_in_context_panel": false
      },
      "ticket_sharing_partners": {
        "support_addresses": [
          "support@grokpetre.zendesk.com"
        ]
      },
      "gooddata_advanced_analytics": {
        "enabled": true
      }
    }
  },
  "properties": {
    "settings": {
      "$ref": "#/components/schemas/AccountSettingsObject"
    }
  }
}

{
  "type": "object",
  "properties": {
    "enabled": {
      "type": "boolean"
    },
    "autorouting_tag": {
      "type": "string"
    },
    "max_email_capacity": {
      "type": "integer"
    },
    "max_messaging_capacity": {
      "type": "integer"
    },
    "reassignment_talk_timeout": {
      "type": "integer"
    },
    "reassignment_messaging_enabled": {
      "type": "boolean"
    },
    "reassignment_messaging_timeout": {
      "type": "integer"
    }
  },
  "description": "Configuration for routing. See [Routing](https://developer.zendesk.com)"
}

{
  "type": "object",
  "properties": {
    "macro_order": {
      "type": "string"
    },
    "macro_most_used": {
      "type": "boolean"
    },
    "using_skill_based_routing": {
      "type": "boolean"
    },
    "skill_based_filtered_views": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true
      }
    }
  },
  "description": "Rules settings for triggers, macros, views, and automations. See [Rules](https://developer.zendesk.com)"
}

{
  "type": "object",
  "properties": {
    "email_channel": {
      "type": "boolean"
    },
    "slack_channel": {
      "type": "boolean"
    },
    "msteams_channel": {
      "type": "boolean"
    },
    "tickets_channel": {
      "type": "boolean"
    },
    "show_in_context_panel": {
      "type": "boolean"
    }
  },
  "description": "Side conversations settings"
}

{
  "type": "object",
  "properties": {
    "forum": {
      "type": "boolean"
    },
    "search": {
      "type": "boolean"
    },
    "rule_usage": {
      "type": "boolean"
    }
  },
  "description": "Account statistics settings. See [Statistics](https://developer.zendesk.com)"
}

{
  "type": "object",
  "properties": {
    "ticket_forms_instructions": {
      "type": "string"
    },
    "raw_ticket_forms_instructions": {
      "type": "string"
    }
  },
  "description": "Ticket form settings. See [Ticket Form](https://developer.zendesk.com)"
}

{
  "type": "object",
  "properties": {
    "tagging": {
      "type": "boolean"
    },
    "status_hold": {
      "type": "boolean"
    },
    "collaboration": {
      "type": "boolean"
    },
    "has_color_text": {
      "type": "boolean"
    },
    "agent_collision": {
      "type": "boolean"
    },
    "list_empty_views": {
      "type": "boolean"
    },
    "allow_group_reset": {
      "type": "boolean"
    },
    "email_attachments": {
      "type": "boolean"
    },
    "rich_text_comments": {
      "type": "boolean"
    },
    "chat_sla_enablement": {
      "type": "boolean"
    },
    "private_attachments": {
      "type": "boolean"
    },
    "emoji_autocompletion": {
      "type": "boolean"
    },
    "agent_ticket_deletion": {
      "type": "boolean"
    },
    "agent_invitation_enabled": {
      "type": "boolean"
    },
    "auto_translation_enabled": {
      "type": "boolean"
    },
    "markdown_ticket_comments": {
      "type": "boolean"
    },
    "assign_tickets_upon_solve": {
      "type": "boolean"
    },
    "using_skill_based_routing": {
      "type": "boolean"
    },
    "comments_public_by_default": {
      "type": "boolean"
    },
    "list_newest_comments_first": {
      "type": "boolean"
    },
    "assign_default_organization": {
      "type": "boolean"
    },
    "light_agent_email_ccs_allowed": {
      "type": "boolean"
    },
    "accepted_new_collaboration_tos": {
      "type": "boolean"
    },
    "maximum_personal_views_to_list": {
      "type": "integer"
    },
    "auto_updated_ccs_followers_rules": {
      "type": "boolean"
    },
    "is_first_comment_private_enabled": {
      "type": "boolean"
    },
    "follower_and_email_cc_collaborations": {
      "type": "boolean"
    }
  },
  "description": "Ticket settings. See [Tickets](https://developer.zendesk.com)"
}

{
  "type": "object",
  "properties": {
    "support_addresses": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "description": "Ticket sharing partners settings. See [Ticket Sharing Partners](https://developer.zendesk.com)"
}

{
  "type": "object",
  "properties": {
    "shorten_url": {
      "type": "string"
    }
  },
  "description": "X (formerly Twitter) settings. See [X](https://developer.zendesk.com)"
}

{
  "type": "object",
  "properties": {
    "tagging": {
      "type": "boolean"
    },
    "language_selection": {
      "type": "boolean"
    },
    "time_zone_selection": {
      "type": "boolean"
    },
    "have_gravatars_enabled": {
      "type": "boolean"
    },
    "multiple_organizations": {
      "type": "boolean"
    },
    "agent_created_welcome_emails": {
      "type": "boolean"
    },
    "end_user_phone_number_validation": {
      "type": "boolean"
    }
  },
  "description": "User settings. See [Users](https://developer.zendesk.com)"
}

{
  "type": "object",
  "properties": {
    "enabled": {
      "type": "boolean"
    },
    "logging": {
      "type": "boolean"
    },
    "outbound_enabled": {
      "type": "boolean"
    },
    "recordings_public": {
      "type": "boolean"
    },
    "maximum_queue_size": {
      "type": "integer"
    },
    "uk_mobile_forwarding": {
      "type": "boolean"
    },
    "maximum_queue_wait_time": {
      "type": "integer"
    },
    "agent_wrap_up_after_calls": {
      "type": "boolean"
    },
    "only_during_business_hours": {
      "type": "boolean"
    },
    "agent_confirmation_when_forwarding": {
      "type": "boolean"
    }
  },
  "description": "Zendesk Talk settings. See [Voice](https://developer.zendesk.com)"
}

{
  "type": "object",
  "properties": {
    "field": {
      "type": "string",
      "description": "The name of a ticket field to modify"
    },
    "value": {
      "type": "string",
      "description": "The new value of the field"
    }
  }
}

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

{
  "type": "object",
  "properties": {
    "count": {
      "type": "object",
      "properties": {
        "value": {
          "type": "integer"
        },
        "refreshed_at": {
          "type": "string",
          "format": "date-time"
        }
      }
    }
  }
}

{
  "type": "object",
  "example": {
    "count": 1,
    "users": [
      {
        "id": 3343,
        "url": "https://example.zendesk.com/api/v2/users/3343.json",
        "name": "Samwise Gamgee",
        "role": "admin",
        "tags": [
          "101"
        ],
        "alias": "test",
        "email": "user@zendesk.com",
        "notes": "test",
        "phone": null,
        "photo": {
          "id": 8730791,
          "url": "https://example.zendesk.com/api/v2/attachments/8730791.json",
          "size": 4566,
          "width": 80,
          "height": 80,
          "inline": false,
          "deleted": false,
          "file_name": "1f84950b8d7949b3.gif",
          "thumbnails": [
            {
              "id": 8730801,
              "url": "https://example.zendesk.com/api/v2/attachments/8730801.json",
              "size": 1517,
              "width": 32,
              "height": 32,
              "inline": false,
              "deleted": false,
              "file_name": "1f84950b8d7949b3_thumb.gif",
              "content_url": "https://example.zendesk.com/system/photos/8730801/1f84950b8d7949b3_thumb.gif",
              "content_type": "image/gif",
              "mapped_content_url": "https://example.zendesk.com/system/photos/8730801/1f84950b8d7949b3_thumb.gif"
            }
          ],
          "content_url": "https://example.zendesk.com/system/photos/8730791/1f84950b8d7949b3.gif",
          "content_type": "image/gif",
          "mapped_content_url": "https://example.zendesk.com/system/photos/8730791/1f84950b8d7949b3.gif"
        },
        "active": true,
        "locale": "en-gb",
        "shared": false,
        "details": "",
        "verified": true,
        "locale_id": 5,
        "moderator": true,
        "role_type": null,
        "signature": "test",
        "suspended": false,
        "time_zone": "American Samoa",
        "created_at": "2017-08-14T20:13:53Z",
        "report_csv": true,
        "updated_at": "2020-11-17T00:33:55Z",
        "external_id": "oev7jj",
        "user_fields": {
          "skittles": "2018-09-14T00:00:00+00:00",
          "user_field_1": "101",
          "its_remember_september": null
        },
        "shared_agent": false,
        "last_login_at": "2020-11-16T22:57:45Z",
        "custom_role_id": null,
        "iana_time_zone": "Pacific/Pago_Pago",
        "organization_id": 1873,
        "default_group_id": 1873,
        "restricted_agent": false,
        "ticket_restriction": null,
        "shared_phone_number": null,
        "only_private_comments": false,
        "two_factor_auth_enabled": null
      }
    ],
    "actors": [
      {
        "id": 158488612,
        "url": "https://example.zendesk.com/api/v2/users/158488612.json",
        "name": "Tedd",
        "role": "admin",
        "tags": [],
        "alias": "",
        "email": "cgoddard+ted@zendesk.com",
        "notes": "",
        "phone": null,
        "photo": null,
        "active": true,
        "locale": "en-gb",
        "shared": false,
        "details": "",
        "verified": true,
        "locale_id": 5,
        "moderator": true,
        "role_type": null,
        "signature": "",
        "suspended": false,
        "time_zone": "Alaska",
        "created_at": "2020-11-17T00:32:12Z",
        "report_csv": true,
        "updated_at": "2020-11-17T00:34:38Z",
        "external_id": null,
        "user_fields": {
          "skittles": null,
          "user_field_1": null,
          "its_remember_september": null
        },
        "shared_agent": false,
        "last_login_at": "2020-11-17T00:33:44Z",
        "custom_role_id": null,
        "iana_time_zone": "America/Juneau",
        "organization_id": null,
        "default_group_id": 1873,
        "restricted_agent": false,
        "ticket_restriction": null,
        "shared_phone_number": null,
        "only_private_comments": false,
        "two_factor_auth_enabled": null
      }
    ],
    "next_page": null,
    "activities": [
      {
        "id": 29183462,
        "url": "https://example.zendesk.com/api/v2/activities/29183462.json",
        "user": {
          "id": 3343,
          "url": "https://example.zendesk.com/api/v2/users/3343.json",
          "name": "Samwise Gamgee",
          "role": "admin",
          "tags": [
            "101"
          ],
          "alias": "test",
          "email": "user@zendesk.com",
          "notes": "test",
          "phone": null,
          "photo": {
            "id": 8730791,
            "url": "https://example.zendesk.com/api/v2/attachments/8730791.json",
            "size": 4566,
            "width": 80,
            "height": 80,
            "inline": false,
            "deleted": false,
            "file_name": "1f84950b8d7949b3.gif",
            "thumbnails": [
              {
                "id": 8730801,
                "url": "https://example.zendesk.com/api/v2/attachments/8730801.json",
                "size": 1517,
                "width": 32,
                "height": 32,
                "inline": false,
                "deleted": false,
                "file_name": "1f84950b8d7949b3_thumb.gif",
                "content_url": "https://example.zendesk.com/system/photos/8730801/1f84950b8d7949b3_thumb.gif",
                "content_type": "image/gif",
                "mapped_content_url": "https://example.zendesk.com/system/photos/8730801/1f84950b8d7949b3_thumb.gif"
              }
            ],
            "content_url": "https://example.zendesk.com/system/photos/8730791/1f84950b8d7949b3.gif",
            "content_type": "image/gif",
            "mapped_content_url": "https://example.zendesk.com/system/photos/8730791/1f84950b8d7949b3.gif"
          },
          "active": true,
          "locale": "en-gb",
          "shared": false,
          "details": "",
          "verified": true,
          "locale_id": 5,
          "moderator": true,
          "role_type": null,
          "signature": "test",
          "suspended": false,
          "time_zone": "American Samoa",
          "created_at": "2017-08-14T20:13:53Z",
          "report_csv": true,
          "updated_at": "2020-11-17T00:33:55Z",
          "external_id": "oev7jj",
          "user_fields": {
            "skittles": "2018-09-14T00:00:00+00:00",
            "user_field_1": "101",
            "its_remember_september": null
          },
          "shared_agent": false,
          "last_login_at": "2020-11-16T22:57:45Z",
          "custom_role_id": null,
          "iana_time_zone": "Pacific/Pago_Pago",
          "organization_id": 1873,
          "default_group_id": 1873,
          "restricted_agent": false,
          "ticket_restriction": null,
          "shared_phone_number": null,
          "only_private_comments": false,
          "two_factor_auth_enabled": null
        },
        "verb": "tickets.assignment",
        "actor": {
          "id": 158488612,
          "url": "https://example.zendesk.com/api/v2/users/158488612.json",
          "name": "Tedd",
          "role": "admin",
          "tags": [],
          "alias": "",
          "email": "cgoddard+ted@zendesk.com",
          "notes": "",
          "phone": null,
          "photo": null,
          "active": true,
          "locale": "en-gb",
          "shared": false,
          "details": "",
          "verified": true,
          "locale_id": 5,
          "moderator": true,
          "role_type": null,
          "signature": "",
          "suspended": false,
          "time_zone": "Alaska",
          "created_at": "2020-11-17T00:32:12Z",
          "report_csv": true,
          "updated_at": "2020-11-17T00:34:38Z",
          "external_id": null,
          "user_fields": {
            "skittles": null,
            "user_field_1": null,
            "its_remember_september": null
          },
          "shared_agent": false,
          "last_login_at": "2020-11-17T00:33:44Z",
          "custom_role_id": null,
          "iana_time_zone": "America/Juneau",
          "organization_id": null,
          "default_group_id": 1873,
          "restricted_agent": false,
          "ticket_restriction": null,
          "shared_phone_number": null,
          "only_private_comments": false,
          "two_factor_auth_enabled": null
        },
        "title": "Tedd assigned ticket #1521 to you.",
        "object": {
          "ticket": {
            "id": 1521,
            "subject": "test"
          }
        },
        "target": {
          "ticket": {
            "id": 1521,
            "subject": "test"
          }
        },
        "user_id": 3343,
        "actor_id": 158488612,
        "created_at": "2020-11-17T00:34:40Z",
        "updated_at": "2020-11-17T00:34:40Z"
      }
    ],
    "previous_page": null
  },
  "properties": {
    "count": {
      "type": "integer",
      "readOnly": true
    },
    "users": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true
      },
      "readOnly": true
    },
    "actors": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true
      },
      "readOnly": true
    },
    "next_page": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    },
    "activities": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ActivityObject"
      },
      "readOnly": true
    },
    "previous_page": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  }
}

{
  "type": "object",
  "title": "Ticket Activities",
  "example": {
    "id": 35,
    "url": "https://company.zendesk.com/api/v2/activities/35.json",
    "user": {
      "id": 223443,
      "name": "Johnny Agent"
    },
    "verb": "tickets.assignment",
    "actor": {
      "id": 8678530,
      "name": "James A. Rosen"
    },
    "title": "John Hopeful assigned ticket #123 to you",
    "object": {},
    "target": {},
    "user_id": 29451,
    "actor_id": 23546,
    "created_at": "2019-03-05T10:38:52Z",
    "updated_at": "2019-03-05T10:38:52Z"
  },
  "properties": {
    "id": {
      "type": "integer",
      "readOnly": true,
      "description": "Automatically assigned on creation"
    },
    "url": {
      "type": "string",
      "readOnly": true,
      "description": "The API url of the activity"
    },
    "user": {
      "$ref": "#/components/schemas/UserObject"
    },
    "verb": {
      "type": "string",
      "readOnly": true,
      "description": "The type of activity. Can be \"tickets.assignment\", \"tickets.comment\", or \"tickets.priority_increase\""
    },
    "actor": {
      "$ref": "#/components/schemas/UserObject"
    },
    "title": {
      "type": "string",
      "readOnly": true,
      "description": "Description of the activity"
    },
    "object": {
      "type": "object",
      "readOnly": true,
      "description": "The content of the activity. Can be a ticket, comment, or change.",
      "additionalProperties": true
    },
    "target": {
      "type": "object",
      "readOnly": true,
      "description": "The target of the activity, a ticket.",
      "additionalProperties": true
    },
    "user_id": {
      "type": "integer",
      "readOnly": true,
      "description": "The id of the agent making the request"
    },
    "actor_id": {
      "type": "integer",
      "readOnly": true,
      "description": "The id of the user responsible for the ticket activity. An `actor_id` of \"-1\" is a Zendesk system user, such as an automations action."
    },
    "created_at": {
      "type": "string",
      "readOnly": true,
      "description": "When the record was created"
    },
    "updated_at": {
      "type": "string",
      "readOnly": true,
      "description": "When the record was last updated"
    }
  },
  "x-konfig-properties": {
    "user": {
      "type": "object",
      "readOnly": true,
      "description": "The full user record of the agent making the request. See [Users](https://developer.zendesk.com)"
    },
    "actor": {
      "type": "object",
      "readOnly": true,
      "description": "The full user record of the user responsible for the ticket activity. See [Users](https://developer.zendesk.com)"
    }
  }
}

{
  "type": "object",
  "example": {
    "activity": {
      "id": 29183462,
      "url": "https://example.zendesk.com/api/v2/activities/29183462.json",
      "user": {
        "id": 3343,
        "url": "https://example.zendesk.com/api/v2/users/3343.json",
        "name": "Samwise Gamgee",
        "role": "admin",
        "tags": [
          "101"
        ],
        "alias": "test",
        "email": "user@zendesk.com",
        "notes": "test",
        "phone": null,
        "photo": {
          "id": 8730791,
          "url": "https://example.zendesk.com/api/v2/attachments/8730791.json",
          "size": 4566,
          "width": 80,
          "height": 80,
          "inline": false,
          "deleted": false,
          "file_name": "1f84950b8d7949b3.gif",
          "thumbnails": [
            {
              "id": 8730801,
              "url": "https://example.zendesk.com/api/v2/attachments/8730801.json",
              "size": 1517,
              "width": 32,
              "height": 32,
              "inline": false,
              "deleted": false,
              "file_name": "1f84950b8d7949b3_thumb.gif",
              "content_url": "https://example.zendesk.com/system/photos/8730801/1f84950b8d7949b3_thumb.gif",
              "content_type": "image/gif",
              "mapped_content_url": "https://example.zendesk.com/system/photos/8730801/1f84950b8d7949b3_thumb.gif"
            }
          ],
          "content_url": "https://example.zendesk.com/system/photos/8730791/1f84950b8d7949b3.gif",
          "content_type": "image/gif",
          "mapped_content_url": "https://example.zendesk.com/system/photos/8730791/1f84950b8d7949b3.gif"
        },
        "active": true,
        "locale": "en-gb",
        "shared": false,
        "details": "",
        "verified": true,
        "locale_id": 5,
        "moderator": true,
        "role_type": null,
        "signature": "test",
        "suspended": false,
        "time_zone": "American Samoa",
        "created_at": "2017-08-14T20:13:53Z",
        "report_csv": true,
        "updated_at": "2020-11-17T00:33:55Z",
        "external_id": "oev7jj",
        "user_fields": {
          "skittles": "2018-09-14T00:00:00+00:00",
          "user_field_1": "101",
          "its_remember_september": null
        },
        "shared_agent": false,
        "last_login_at": "2020-11-16T22:57:45Z",
        "custom_role_id": null,
        "iana_time_zone": "Pacific/Pago_Pago",
        "organization_id": 1873,
        "default_group_id": 1873,
        "restricted_agent": false,
        "ticket_restriction": null,
        "shared_phone_number": null,
        "only_private_comments": false,
        "two_factor_auth_enabled": null
      },
      "verb": "tickets.assignment",
      "actor": {
        "id": 158488612,
        "url": "https://example.zendesk.com/api/v2/users/158488612.json",
        "name": "Tedd",
        "role": "admin",
        "tags": [],
        "alias": "",
        "email": "cgoddard+ted@zendesk.com",
        "notes": "",
        "phone": null,
        "photo": null,
        "active": true,
        "locale": "en-gb",
        "shared": false,
        "details": "",
        "verified": true,
        "locale_id": 5,
        "moderator": true,
        "role_type": null,
        "signature": "",
        "suspended": false,
        "time_zone": "Alaska",
        "created_at": "2020-11-17T00:32:12Z",
        "report_csv": true,
        "updated_at": "2020-11-17T00:34:38Z",
        "external_id": null,
        "user_fields": {
          "skittles": null,
          "user_field_1": null,
          "its_remember_september": null
        },
        "shared_agent": false,
        "last_login_at": "2020-11-17T00:33:44Z",
        "custom_role_id": null,
        "iana_time_zone": "America/Juneau",
        "organization_id": null,
        "default_group_id": 1873,
        "restricted_agent": false,
        "ticket_restriction": null,
        "shared_phone_number": null,
        "only_private_comments": false,
        "two_factor_auth_enabled": null
      },
      "title": "Tedd assigned ticket #1521 to you.",
      "object": {
        "ticket": {
          "id": 1521,
          "subject": "test"
        }
      },
      "target": {
        "ticket": {
          "id": 1521,
          "subject": "test"
        }
      },
      "user_id": 3343,
      "actor_id": 158488612,
      "created_at": "2020-11-17T00:34:40Z",
      "updated_at": "2020-11-17T00:34:40Z"
    }
  },
  "properties": {
    "activity": {
      "$ref": "#/components/schemas/ActivityObject"
    }
  }
}

{
  "type": "object",
  "title": "AssigneeFieldAssignableAgents",
  "example": {
    "id": 6473829100,
    "name": "Joe Smith",
    "avatar_url": "https://z3n-example.zendesk.com/system/photos/900005192023/my_profile.png"
  },
  "properties": {
    "id": {
      "type": "integer",
      "description": "Agent Support ID"
    },
    "name": {
      "type": "string",
      "description": "Name of the agent"
    },
    "avatar_url": {
      "type": "string",
      "nullable": true,
      "description": "URL of Agent's avatar"
    }
  }
}

{
  "type": "object",
  "example": {
    "count": 3,
    "agents": [
      {
        "id": 6473829100,
        "name": "Joe Smith",
        "avatar_url": "https://z3n-example.zendesk.com/system/photos/900005192023/my_profile.png"
      },
      {
        "id": 9182736400,
        "name": "Jane Doe",
        "avatar_url": "https://z3n-example.zendesk.com/system/photos/412005192023/my_profile.png"
      },
      {
        "id": 1928373460,
        "name": "Cookie Monster",
        "avatar_url": "https://z3n-example.zendesk.com/system/photos/887005192023/my_profile.png"
      }
    ],
    "next_page": null,
    "previous_page": null
  },
  "properties": {
    "count": {
      "type": "integer",
      "description": "Number of agents listed in `agents` property."
    },
    "agents": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AssigneeFieldAssignableAgentObject"
      }
    },
    "next_page": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    },
    "previous_page": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  }
}

{
  "type": "object",
  "title": "AssigneeFieldAssignableGroups",
  "example": {
    "id": 9182736455,
    "name": "Engineering",
    "description": "Engineering team for bugs"
  },
  "properties": {
    "id": {
      "type": "integer",
      "readOnly": true,
      "description": "Group ID"
    },
    "name": {
      "type": "string",
      "readOnly": true,
      "description": "Name of the group"
    },
    "description": {
      "type": "string",
      "readOnly": true,
      "description": "Description of the group"
    }
  }
}

{
  "type": "object",
  "example": {
    "count": 2,
    "agents": [
      {
        "id": 8392017465,
        "name": "Sam Technologist",
        "group": "Tech",
        "group_id": 6574839201,
        "photo_url": "https://z3n-example.zendesk.com/system/photos/410305192023/my_profile.png"
      }
    ],
    "groups": [
      {
        "id": 6574839201,
        "name": "Tech"
      }
    ]
  },
  "properties": {
    "count": {
      "type": "integer",
      "description": "Number of agents + groups listed from search result."
    },
    "agents": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AssigneeFieldAssignableSearchAgentObject"
      }
    },
    "groups": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AssigneeFieldAssignableSearchGroupObject"
      }
    }
  }
}

{
  "type": "object",
  "example": {
    "count": 3,
    "groups": [
      {
        "id": 9182736455,
        "name": "Group for Bugs for Engineering",
        "description": "Engineering"
      },
      {
        "id": 1928374655,
        "name": "Group for feature requests",
        "description": "Product"
      },
      {
        "id": 5519283746,
        "name": "Group for customer inquiries",
        "description": "Customer Support"
      }
    ],
    "next_page": null,
    "previous_page": null
  },
  "properties": {
    "count": {
      "type": "integer",
      "description": "Number of groups listed in `groups` property."
    },
    "groups": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AssigneeFieldAssignableGroupObject"
      }
    },
    "next_page": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    },
    "previous_page": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  }
}

{
  "type": "object",
  "example": {
    "id": 6473829100,
    "name": "Joe Smith",
    "group": "Engineering",
    "group_id": 9182736455,
    "photo_url": "https://z3n-example.zendesk.com/system/photos/900005192023/my_profile.png"
  },
  "properties": {
    "id": {
      "type": "integer",
      "description": "Agent ID"
    },
    "name": {
      "type": "string",
      "description": "Name of the agent"
    },
    "group": {
      "type": "string",
      "description": "Name of the agent's group"
    },
    "group_id": {
      "type": "integer",
      "description": "Agent's Group ID"
    },
    "photo_url": {
      "type": "string",
      "nullable": true,
      "description": "URL of Avatar"
    }
  }
}

{
  "type": "object",
  "example": {
    "id": 9182736455,
    "name": "Engineering"
  },
  "properties": {
    "id": {
      "type": "integer",
      "description": "Group ID"
    },
    "name": {
      "type": "string",
      "description": "Name of the group"
    }
  }
}

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "readOnly": true,
      "description": "Automatically assigned when created"
    },
    "url": {
      "type": "string",
      "readOnly": true,
      "description": "A URL to access the attachment details"
    },
    "size": {
      "type": "integer",
      "readOnly": true,
      "description": "The size of the image file in bytes"
    },
    "width": {
      "type": "string",
      "readOnly": true,
      "description": "The width of the image file in pixels. If width is unknown, returns null"
    },
    "height": {
      "type": "string",
      "readOnly": true,
      "description": "The height of the image file in pixels. If height is unknown, returns null"
    },
    "inline": {
      "type": "boolean",
      "readOnly": true,
      "description": "If true, the attachment is excluded from the attachment list and the attachment's URL\ncan be referenced within the comment of a ticket. Default is false\n"
    },
    "deleted": {
      "type": "boolean",
      "readOnly": true,
      "description": "If true, the attachment has been deleted"
    },
    "file_name": {
      "type": "string",
      "readOnly": true,
      "description": "The name of the image file"
    },
    "content_url": {
      "type": "string",
      "readOnly": true,
      "description": "A full URL where the attachment image file can be downloaded. The file may be hosted externally so take care not to inadvertently send Zendesk authentication credentials. See [Working with url properties](https://developer.zendesk.com)"
    },
    "content_type": {
      "type": "string",
      "readOnly": true,
      "description": "The content type of the image. Example value: \"image/png\""
    },
    "mapped_content_url": {
      "type": "string",
      "readOnly": true,
      "description": "The URL the attachment image file has been mapped to"
    },
    "malware_scan_result": {
      "type": "string",
      "readOnly": true,
      "description": "The result of the malware scan. There is a delay between the time the attachment is uploaded and when the malware scan is completed. Usually the scan is done within a few seconds, but high load conditions can delay the scan results. Possible values: \"malware_found\", \"malware_not_found\", \"failed_to_scan\", \"not_scanned\""
    },
    "malware_access_override": {
      "type": "boolean",
      "readOnly": true,
      "description": "If true, you can download an attachment flagged as malware. If false, you can't download such an attachment."
    }
  }
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/AttachmentBaseObject"
    },
    {
      "$ref": "#/components/schemas/AttachmentThumbnails"
    }
  ],
  "example": {
    "id": 928374,
    "size": 166144,
    "file_name": "my_funny_profile_pic.png",
    "thumbnails": [
      {
        "id": 928375,
        "size": 58298,
        "file_name": "my_funny_profile_pic_thumb.png",
        "content_url": "https://company.zendesk.com/attachments/my_funny_profile_pic_thumb.png",
        "content_type": "image/png"
      }
    ],
    "content_url": "https://company.zendesk.com/attachments/my_funny_profile_pic.png",
    "content_type": "image/png"
  },
  "description": "A file represented as an [Attachment](https://developer.zendesk.com) object"
}

{
  "type": "object",
  "properties": {
    "attachment": {
      "$ref": "#/components/schemas/AttachmentObject"
    }
  }
}

{
  "type": "object",
  "properties": {
    "thumbnails": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AttachmentBaseObject"
      },
      "readOnly": true,
      "description": "An array of attachment objects. Note that photo thumbnails do not have thumbnails"
    }
  }
}

{
  "type": "object",
  "properties": {
    "malware_access_override": {
      "type": "boolean",
      "description": "If true, allows access to attachments with detected malware."
    }
  }
}

{
  "type": "object",
  "properties": {
    "attachment": {
      "$ref": "#/components/schemas/AttachmentUpdateInput"
    }
  }
}

{
  "type": "object",
  "properties": {
    "upload": {
      "type": "object",
      "properties": {
        "token": {
          "type": "string",
          "readOnly": true,
          "description": "Token for subsequent request"
        },
        "attachment": {
          "$ref": "#/components/schemas/AttachmentObject"
        },
        "attachments": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/AttachmentObject"
          }
        }
      }
    }
  }
}

{
  "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"
      }
    }
  }
}

{
  "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)"
    }
  }
}

{
  "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"
    }
  }
}

{
  "type": "object",
  "properties": {
    "custom_object_field": {
      "$ref": "#/components/schemas/CustomFieldObject"
    }
  }
}

{
  "type": "object",
  "properties": {
    "custom_object_field": {
      "$ref": "#/components/schemas/CustomFieldObject"
    }
  }
}

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

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

{
  "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"
    }
  }
}

{
  "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
    }
  }
}

{
  "type": "object",
  "properties": {
    "custom_object_record": {
      "$ref": "#/components/schemas/CustomObjectRecord"
    }
  }
}

{
  "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"
        }
      }
    }
  }
}

{
  "type": "object",
  "properties": {
    "custom_object_record": {
      "$ref": "#/components/schemas/CustomObjectRecord"
    }
  }
}

{
  "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"
          }
        }
      }
    }
  }
}

{
  "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
        }
      }
    }
  }
}

{
  "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"
      }
    }
  }
}

{
  "type": "object",
  "properties": {
    "custom_object_record": {
      "$ref": "#/components/schemas/CustomObjectRecord"
    }
  }
}

{
  "type": "object",
  "properties": {
    "custom_object": {
      "$ref": "#/components/schemas/CustomObject"
    }
  }
}

{
  "type": "object",
  "properties": {
    "custom_object": {
      "$ref": "#/components/schemas/CustomObjectCreateInput"
    }
  }
}

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

{
  "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)"
}

{
  "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"
    }
  }
}

{
  "type": "object",
  "properties": {
    "custom_role": {
      "$ref": "#/components/schemas/CustomRoleObject"
    }
  }
}

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

{
  "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"
        }
      }
    }
  ]
}

{
  "type": "object",
  "properties": {
    "custom_status": {
      "$ref": "#/components/schemas/CustomStatusCreateInput"
    }
  }
}

{
  "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)"
    }
  }
}

{
  "type": "object",
  "properties": {
    "custom_status": {
      "$ref": "#/components/schemas/CustomStatusObject"
    }
  }
}

{
  "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)"
    }
  }
}

{
  "type": "object",
  "properties": {
    "custom_status": {
      "$ref": "#/components/schemas/CustomStatusUpdateInput"
    }
  }
}

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

{
  "type": "object",
  "example": {},
  "properties": {}
}

{
  "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"
              }
            }
          }
        }
      }
    }
  }
}

{
  "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
    }
  }
}

{
  "type": "object",
  "properties": {
    "deleted_user": {
      "$ref": "#/components/schemas/DeletedUserObject"
    }
  }
}

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

{
  "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)."
    }
  }
}

{
  "type": "object",
  "properties": {
    "item": {
      "$ref": "#/components/schemas/DynamicContentObject"
    }
  }
}

{
  "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"
    }
  }
}

{
  "type": "object",
  "properties": {
    "variant": {
      "$ref": "#/components/schemas/DynamicContentVariantObject"
    }
  }
}

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

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

{
  "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"
        }
      }
    }
  ]
}

{
  "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"
    }
  }
}

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

{
  "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"
    }
  }
}

{
  "type": "object",
  "properties": {
    "object_layout": {
      "$ref": "#/components/schemas/EssentialsCardObject"
    }
  }
}

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

{
  "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"
      }
    }
  }
}

{
  "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"
      }
    }
  }
}

{
  "type": "object",
  "properties": {
    "action": {
      "enum": [
        "put",
        "delete"
      ],
      "type": "string"
    },
    "user_id": {
      "type": "string"
    },
    "user_email": {
      "type": "string",
      "format": "email"
    }
  }
}

{
  "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"
    }
  }
}

{
  "type": "object",
  "properties": {
    "group_membership": {
      "$ref": "#/components/schemas/GroupMembershipObject"
    }
  }
}

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

{
  "type": "object",
  "example": {
    "id": 3432,
    "url": "https://company.zendesk.com/api/v2/groups/3432.json",
    "name": "First Level Support",
    "default": true,
    "deleted": false,
    "is_public": true,
    "created_at": "2009-07-20T22:55:29Z",
    "updated_at": "2011-05-05T10:38:52Z",
    "description": "Some clever description here"
  },
  "required": [
    "name"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "readOnly": true,
      "description": "Automatically assigned when creating groups"
    },
    "url": {
      "type": "string",
      "readOnly": true,
      "description": "The API url of the group"
    },
    "name": {
      "type": "string",
      "description": "The name of the group"
    },
    "default": {
      "type": "boolean",
      "readOnly": true,
      "description": "If the group is the default one for the account"
    },
    "deleted": {
      "type": "boolean",
      "readOnly": true,
      "description": "Deleted groups get marked as such"
    },
    "is_public": {
      "type": "boolean",
      "description": "If true, the group is public.\nIf false, the group is private.\nYou can't change a private group to a public group\n"
    },
    "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"
    },
    "description": {
      "type": "string",
      "description": "The description of the group"
    }
  }
}

{
  "type": "object",
  "properties": {
    "group": {
      "$ref": "#/components/schemas/GroupObject"
    }
  }
}

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

{
  "type": "object",
  "properties": {
    "field": {
      "type": "string",
      "description": "The name of a ticket field"
    },
    "value": {
      "type": "array",
      "items": {
        "oneOf": [
          {
            "type": "string"
          },
          {
            "type": "integer"
          }
        ]
      },
      "description": "The value of a ticket field"
    },
    "operator": {
      "type": "string",
      "description": "A comparison operator"
    }
  }
}

{
  "type": "object",
  "properties": {
    "definitions": {
      "type": "object",
      "properties": {
        "all": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "group": {
                "type": "string"
              },
              "title": {
                "type": "string"
              },
              "value": {
                "type": "string"
              },
              "values": {
                "type": "object",
                "properties": {
                  "list": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "title": {
                          "type": "string"
                        },
                        "value": {
                          "type": "integer",
                          "nullable": true
                        }
                      }
                    }
                  },
                  "type": {
                    "type": "string"
                  }
                }
              },
              "operators": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "title": {
                      "type": "string"
                    },
                    "value": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

{
  "type": "object",
  "properties": {
    "all": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/GroupSLAPolicyFilterConditionObject"
      }
    }
  },
  "description": "An object that describes the conditions a ticket must match for a Group SLA policy to be applied to the ticket. See [Filter](https://developer.zendesk.com)."
}

{
  "type": "object",
  "properties": {
    "metric": {
      "type": "string",
      "description": "The definition of the time that is being measured"
    },
    "target": {
      "type": "integer",
      "description": "The time within which the end-state for a metric should be met"
    },
    "priority": {
      "type": "string",
      "description": "Priority that a ticket must match"
    },
    "business_hours": {
      "type": "boolean",
      "description": "Whether the metric targets are being measured in business hours or calendar hours"
    }
  }
}

{
  "type": "object",
  "example": {
    "id": "01H078CBDY28BZG7P6BONY09DN",
    "url": "https://company.zendesk.com/api/v2/group_slas/policies/01H078CBDY28BZG7P6BONY09DN.json",
    "title": "Tier 1",
    "filter": {
      "all": []
    },
    "position": 3,
    "created_at": "2023-03-17T22:50:26Z",
    "updated_at": "2023-03-17T22:50:26Z",
    "description": "Group: Tier 1",
    "policy_metrics": [
      {
        "metric": "group_ownership_time",
        "target": 3600,
        "priority": "low",
        "business_hours": false
      }
    ]
  },
  "required": [
    "title",
    "filter"
  ],
  "properties": {
    "id": {
      "type": "string",
      "readOnly": true,
      "description": "Automatically assigned when created"
    },
    "url": {
      "type": "string",
      "readOnly": true,
      "description": "URL of the Group SLA policy record"
    },
    "title": {
      "type": "string",
      "description": "The title of the Group SLA policy"
    },
    "filter": {
      "$ref": "#/components/schemas/GroupSLAPolicyFilterObject"
    },
    "position": {
      "type": "integer",
      "description": "Position of the Group SLA policy. This position determines the order in which policies are matched to tickets. If not specified, the Group SLA policy is added at the last position"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true,
      "description": "The time the Group SLA policy was created"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true,
      "description": "The time of the last update of the Group SLA policy"
    },
    "description": {
      "type": "string",
      "description": "The description of the Group SLA policy"
    },
    "policy_metrics": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/GroupSLAPolicyMetricObject"
      },
      "description": "Array of [policy metric](https://developer.zendesk.com) objects"
    }
  }
}

{
  "type": "object",
  "properties": {
    "group_sla_policy": {
      "$ref": "#/components/schemas/GroupSLAPolicyObject"
    }
  }
}