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

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

{
  "type": "object",
  "properties": {
    "count": {
      "type": "object",
      "properties": {
        "value": {
          "type": "integer",
          "readOnly": true,
          "description": "Approximate count of groups"
        },
        "refreshed_at": {
          "type": "string",
          "format": "date-time",
          "readOnly": true,
          "description": "Timestamp that indicates when the count was last updated"
        }
      }
    }
  }
}

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

{
  "type": "object",
  "title": "Host Mapping",
  "example": {
    "cname": "google.com",
    "reason": "wrong_cname",
    "is_valid": false,
    "expected_cnames": [
      "bar.zendesk.coom"
    ]
  },
  "properties": {
    "cname": {
      "type": "string",
      "description": "The canonical name record for a host mapping"
    },
    "reason": {
      "type": "string",
      "description": "Reason why a host mapping is valid or not"
    },
    "is_valid": {
      "type": "boolean",
      "description": "Whether a host mapping is valid or not for a given brand"
    },
    "expected_cnames": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Array of expected CNAME records for host mapping(s) of a given brand"
    }
  }
}

{
  "type": "object",
  "title": "Incremental Skill-based Routing",
  "properties": {
    "count": {
      "type": "integer",
      "readOnly": true,
      "description": "The number of results returned for the current request"
    },
    "end_time": {
      "type": "integer",
      "readOnly": true,
      "description": "The most recent resource creation time present in this result set in Unix epoch time"
    },
    "next_page": {
      "type": "string",
      "readOnly": true,
      "description": "The URL that should be called to get the next set of results"
    },
    "attributes": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/IncrementalSkillBasedRoutingAttribute"
      },
      "description": "Routing attributes"
    },
    "instance_values": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/IncrementalSkillBasedRoutingInstanceValue"
      },
      "description": "Routing instance values"
    },
    "attribute_values": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/IncrementalSkillBasedRoutingAttributeValue"
      },
      "description": "Routing attribute values"
    }
  }
}

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "readOnly": true,
      "description": "Automatically assigned when an attribute is created"
    },
    "name": {
      "type": "string",
      "readOnly": true,
      "description": "The name of the attribute"
    },
    "time": {
      "type": "string",
      "format": "date-time",
      "readOnly": true,
      "description": "The time the attribute was created, updated, or deleted"
    },
    "type": {
      "type": "string",
      "readOnly": true,
      "description": "One of \"create\", \"update\", or \"delete\""
    }
  }
}

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "readOnly": true,
      "description": "Automatically assigned when an attribute value is created"
    },
    "name": {
      "type": "string",
      "readOnly": true,
      "description": "The name of the attribute value"
    },
    "time": {
      "type": "string",
      "format": "date-time",
      "readOnly": true,
      "description": "The time the attribute value was created, updated, or deleted"
    },
    "type": {
      "type": "string",
      "readOnly": true,
      "description": "One of \"create\", \"update\", or \"delete\""
    },
    "attribute_id": {
      "type": "string",
      "readOnly": true,
      "description": "Id of the associated attribute"
    }
  }
}

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "readOnly": true,
      "description": "Automatically assigned when an instance value is created"
    },
    "time": {
      "type": "string",
      "format": "date-time",
      "readOnly": true,
      "description": "The time the instance value was created or deleted"
    },
    "type": {
      "type": "string",
      "readOnly": true,
      "description": "One of \"associate_agent\", \"unassociate_agent\", \"associate_ticket\", or \"unassociate_ticket\""
    },
    "instance_id": {
      "type": "string",
      "readOnly": true,
      "description": "Id of the associated agent or ticket"
    },
    "attribute_value_id": {
      "type": "string",
      "readOnly": true,
      "description": "Id of the associated attribute value"
    }
  }
}

{
  "type": "object",
  "example": {
    "id": "82de0b044094f0c67893ac9fe64f1a99",
    "url": "https://example.zendesk.com/api/v2/job_statuses/82de0b0467893ac9fe64f1a99.json",
    "total": 2,
    "status": "completed",
    "message": "Completed at 2018-03-08 10:07:04 +0000",
    "results": [
      {
        "id": 244,
        "action": "update",
        "status": "Updated",
        "success": true
      },
      {
        "id": 245,
        "action": "update",
        "status": "Updated",
        "success": true
      }
    ],
    "progress": 2
  },
  "properties": {
    "id": {
      "type": "string",
      "readOnly": true,
      "description": "Automatically assigned when the job is queued"
    },
    "url": {
      "type": "string",
      "readOnly": true,
      "description": "The URL to poll for status updates"
    },
    "total": {
      "type": "integer",
      "nullable": true,
      "readOnly": true,
      "description": "The total number of tasks this job is batching through"
    },
    "status": {
      "type": "string",
      "readOnly": true,
      "description": "The current status. One of the following: \"queued\", \"working\", \"failed\", \"completed\""
    },
    "message": {
      "type": "string",
      "nullable": true,
      "readOnly": true,
      "description": "Message from the job worker, if any"
    },
    "results": {
      "oneOf": [
        {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/JobStatusResultObject"
          },
          "nullable": true
        },
        {
          "type": "object",
          "required": [
            "success"
          ],
          "properties": {
            "success": {
              "type": "boolean",
              "readOnly": true,
              "description": "Whether the action was successful or not"
            }
          }
        }
      ],
      "readOnly": true,
      "description": "Result data from processed tasks. See [Results](https://developer.zendesk.com) below"
    },
    "job_type": {
      "type": "string",
      "readOnly": true,
      "description": "The type of the job"
    },
    "progress": {
      "type": "integer",
      "nullable": true,
      "readOnly": true,
      "description": "Number of tasks that have already been completed"
    }
  }
}

{
  "type": "object",
  "properties": {
    "job_status": {
      "$ref": "#/components/schemas/JobStatusObject"
    }
  }
}

{
  "oneOf": [
    {
      "$ref": "#/components/schemas/CreateResourceResult"
    },
    {
      "$ref": "#/components/schemas/UpdateResourceResult"
    }
  ],
  "additionalProperties": true
}

{
  "type": "object",
  "required": [
    "job_statuses"
  ],
  "properties": {
    "job_statuses": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/JobStatusObject"
      }
    }
  }
}

{
  "type": "object",
  "allOf": [
    {
      "type": "object",
      "properties": {
        "deleted_tickets": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "integer"
              },
              "actor": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "integer"
                  },
                  "name": {
                    "type": "string"
                  }
                }
              },
              "subject": {
                "type": "string"
              },
              "deleted_at": {
                "type": "string"
              },
              "previous_state": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    {
      "$ref": "#/components/schemas/OffsetPaginationObject"
    }
  ]
}

{
  "type": "object",
  "additionalProperties": true
}

{
  "type": "object",
  "additionalProperties": true
}

{
  "type": "object",
  "additionalProperties": true
}

{
  "type": "object",
  "additionalProperties": true
}

{
  "type": "object",
  "additionalProperties": true
}

{
  "type": "object",
  "example": {
    "id": 1,
    "url": "https://company.zendesk.com/api/v2/locales/en-US.json",
    "name": "English",
    "locale": "en-US",
    "created_at": "2009-07-20T22:55:29Z",
    "updated_at": "2011-05-05T10:38:52Z"
  },
  "properties": {
    "id": {
      "type": "integer",
      "readOnly": true,
      "description": "The unique ID of the locale"
    },
    "url": {
      "type": "string",
      "readOnly": true,
      "description": "The URL of the locale record"
    },
    "name": {
      "type": "string",
      "readOnly": true,
      "description": "The name of the language"
    },
    "locale": {
      "type": "string",
      "readOnly": true,
      "description": "The name of the locale"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true,
      "description": "The ISO 8601 formatted date-time the locale was created"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true,
      "description": "The ISO 8601 formatted date-time when the locale was last updated"
    }
  }
}

{
  "type": "object",
  "properties": {
    "locale": {
      "$ref": "#/components/schemas/LocaleObject"
    }
  }
}

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

{
  "type": "object",
  "properties": {
    "result": {
      "type": "object",
      "properties": {
        "ticket": {
          "type": "object",
          "properties": {
            "id": {
              "type": "integer"
            },
            "url": {
              "type": "string"
            },
            "fields": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "integer"
                },
                "value": {
                  "type": "string"
                }
              }
            },
            "comment": {
              "type": "object",
              "properties": {
                "body": {
                  "type": "string"
                },
                "public": {
                  "type": "boolean"
                },
                "scoped_body": {
                  "type": "array",
                  "items": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  }
                }
              }
            },
            "group_id": {
              "type": "integer"
            },
            "assignee_id": {
              "type": "integer"
            }
          }
        }
      }
    }
  }
}

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "readOnly": true,
      "description": "Automatically assigned when created"
    },
    "size": {
      "type": "integer",
      "readOnly": true,
      "description": "The size of the image file in bytes"
    },
    "filename": {
      "type": "string",
      "readOnly": true,
      "description": "The name of the image file"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "The time when this attachment was created"
    },
    "content_url": {
      "type": "string",
      "readOnly": true,
      "description": "A full URL where the attachment image file can be downloaded"
    },
    "content_type": {
      "type": "string",
      "readOnly": true,
      "description": "The content type of the image. Example value: \"image/png\""
    }
  }
}

{
  "type": "object",
  "properties": {
    "macro_attachment": {
      "$ref": "#/components/schemas/MacroAttachmentObject"
    }
  }
}

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

{
  "type": "object",
  "properties": {
    "categories": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}

{
  "type": "object",
  "example": {
    "id": 360111062754,
    "url": "https://subdomain.zendesk.com/api/v2/macros/360111062754.json",
    "title": "Close and redirect to topics",
    "active": true,
    "actions": [
      {
        "field": "status",
        "value": "solved"
      },
      {
        "field": "priority",
        "value": "normal"
      },
      {
        "field": "type",
        "value": "incident"
      },
      {
        "field": "assignee_id",
        "value": "current_user"
      },
      {
        "field": "group_id",
        "value": "current_groups"
      },
      {
        "field": "comment_value",
        "value": "Thanks for your request. This issue you reported is a known issue. For more information, please visit our forums. "
      }
    ],
    "default": false,
    "position": 9999,
    "created_at": "2019-09-16T02:17:38Z",
    "updated_at": "2019-09-16T02:17:38Z",
    "description": null,
    "restriction": null
  },
  "required": [
    "actions",
    "title"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "description": "The ID automatically assigned when a macro is created"
    },
    "url": {
      "type": "string",
      "description": "A URL to access the macro's details"
    },
    "title": {
      "type": "string",
      "description": "The title of the macro"
    },
    "active": {
      "type": "boolean",
      "description": "Useful for determining if the macro should be displayed"
    },
    "actions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ActionObject"
      },
      "description": "Each action describes what the macro will do. See [Actions reference](https://developer.zendesk.com)"
    },
    "default": {
      "type": "boolean",
      "readOnly": true,
      "description": "If true, the macro is a default macro"
    },
    "position": {
      "type": "integer",
      "description": "The position of the macro"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "The time the macro was created"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "The time of the last update of the macro"
    },
    "description": {
      "type": "string",
      "nullable": true,
      "description": "The description of the macro"
    },
    "restriction": {
      "type": "object",
      "nullable": true,
      "description": "Access to this macro. A null value allows unrestricted access for all users in the account",
      "additionalProperties": true
    }
  }
}

{
  "type": "object",
  "required": [
    "title",
    "actions"
  ],
  "properties": {
    "title": {
      "type": "string",
      "description": "The title of the macro"
    },
    "active": {
      "type": "boolean",
      "description": "Useful for determining if the macro should be displayed"
    },
    "actions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ActionObject"
      },
      "description": "Each action describes what the macro will do"
    },
    "description": {
      "type": "string",
      "nullable": true,
      "description": "The description of the macro"
    },
    "restriction": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "The numeric ID of the group or user"
        },
        "ids": {
          "type": "array",
          "items": {
            "type": "integer"
          },
          "description": "The numeric IDs of the groups"
        },
        "type": {
          "type": "string",
          "description": "Allowed values are Group or User"
        }
      },
      "description": "Who may access this macro. Will be null when everyone in the account can access it",
      "additionalProperties": true
    }
  }
}

{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/MacroCommonObject"
    },
    {
      "type": "object",
      "properties": {
        "usage_1h": {
          "type": "integer",
          "description": "The number of times each macro has been used in the past hour"
        },
        "usage_7d": {
          "type": "integer",
          "description": "The number of times each macro has been used in the past week"
        },
        "usage_24h": {
          "type": "integer",
          "description": "The number of times each macro has been used in the past day"
        },
        "usage_30d": {
          "type": "integer",
          "description": "The number of times each macro has been used in the past thirty days"
        },
        "categories": {
          "type": "string",
          "nullable": true,
          "description": "The macro categories"
        },
        "permissions": {
          "type": "string",
          "nullable": true,
          "description": "Permissions for each macro"
        },
        "app_installation": {
          "type": "string",
          "nullable": true,
          "description": "The app installation that requires each macro, if present"
        }
      }
    }
  ],
  "example": {
    "id": 25,
    "title": "Close and Save",
    "active": true,
    "actions": [],
    "position": 42,
    "description": "Sets the ticket status to `solved`",
    "restriction": {
      "id": 4,
      "type": "User"
    }
  }
}

{
  "type": "object",
  "properties": {
    "macro": {
      "$ref": "#/components/schemas/MacroObject"
    }
  }
}

{
  "type": "object",
  "properties": {
    "macros": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "id"
        ],
        "properties": {
          "id": {
            "type": "integer",
            "description": "The ID of the macro to update"
          },
          "active": {
            "type": "boolean",
            "description": "The active status of the macro (true or false)"
          },
          "position": {
            "type": "integer",
            "description": "The new position of the macro"
          }
        }
      }
    }
  }
}

{
  "type": "object",
  "properties": {
    "macro": {
      "$ref": "#/components/schemas/MacroInput"
    }
  }
}

{
  "type": "object",
  "properties": {
    "macro": {
      "$ref": "#/components/schemas/MacroObject"
    }
  }
}

{
  "type": "object",
  "properties": {
    "definitions": {
      "type": "object",
      "properties": {
        "actions": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": true
          }
        }
      }
    }
  }
}

{
  "type": "object",
  "properties": {
    "actions": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true
      }
    }
  }
}

{
  "type": "object",
  "allOf": [
    {
      "type": "object",
      "properties": {
        "macros": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/MacroObject"
          }
        }
      }
    },
    {
      "$ref": "#/components/schemas/OffsetPaginationObject"
    }
  ]
}

{
  "type": "object",
  "properties": {
    "macro": {
      "$ref": "#/components/schemas/MacroInput"
    }
  }
}

{
  "type": "object",
  "properties": {
    "macro": {
      "$ref": "#/components/schemas/MacroObject"
    }
  }
}

{
  "type": "object",
  "properties": {
    "count": {
      "type": "integer",
      "description": "the total record count"
    },
    "next_page": {
      "type": "string",
      "format": "url",
      "nullable": true,
      "description": "the URL of the next page"
    },
    "previous_page": {
      "type": "string",
      "format": "url",
      "nullable": true,
      "description": "the URL of the previous page"
    }
  }
}