object OrganizationFieldResponse
{
  "type": "object",
  "properties": {
    "organization_field": {
      "$ref": "#/components/schemas/CustomFieldObject"
    }
  }
}
string OrganizationFieldsReorderFieldResponse
{
  "type": "string",
  "example": "",
  "description": "Empty response"
}
object OrganizationFieldsResponse
{
  "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"
    },
    "organization_fields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CustomFieldObject"
      }
    }
  }
}
object OrganizationMembershipObject
{
  "type": "object",
  "example": {
    "id": 4,
    "url": "https://example.zendesk.com/api/v2/organization_memberships/4.json",
    "default": true,
    "user_id": 29,
    "created_at": "2009-05-13T00:07:08Z",
    "updated_at": "2011-07-22T00:11:12Z",
    "view_tickets": true,
    "organization_id": 12,
    "organization_name": "first organization"
  },
  "required": [
    "user_id",
    "organization_id",
    "default"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "readOnly": true,
      "description": "Automatically assigned when the membership is created"
    },
    "url": {
      "type": "string",
      "readOnly": true,
      "description": "The API url of this membership"
    },
    "default": {
      "type": "boolean",
      "nullable": true,
      "description": "Denotes whether this is the default organization membership for the user. If false, returns `null`"
    },
    "user_id": {
      "type": "integer",
      "readOnly": true,
      "description": "The ID of the user for whom this memberships belongs"
    },
    "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 last got updated"
    },
    "view_tickets": {
      "type": "boolean",
      "readOnly": true,
      "description": "Denotes whether the user can or cannot have access to all organization's tickets."
    },
    "organization_id": {
      "type": "integer",
      "readOnly": true,
      "description": "The ID of the organization associated with this user, in this membership"
    },
    "organization_name": {
      "type": "string",
      "readOnly": true,
      "description": "The name of the organization associated with this user, in this membership"
    }
  }
}
object OrganizationMembershipResponse
{
  "type": "object",
  "properties": {
    "organization_membership": {
      "$ref": "#/components/schemas/OrganizationMembershipObject"
    }
  }
}
object OrganizationMembershipsResponse
{
  "type": "object",
  "properties": {
    "organization_memberships": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/OrganizationMembershipObject"
      }
    }
  }
}
object OrganizationMergeListResponse
{
  "type": "object",
  "properties": {
    "organization_merges": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "string"
          },
          "url": {
            "type": "string",
            "format": "string"
          },
          "status": {
            "enum": [
              "new",
              "in_progress",
              "error",
              "complete"
            ],
            "type": "string"
          },
          "loser_id": {
            "type": "integer"
          },
          "winner_id": {
            "type": "integer"
          }
        }
      },
      "required": [
        "id",
        "url",
        "loser_id",
        "winner_id",
        "status"
      ]
    }
  }
}
object OrganizationMergeRequest
{
  "type": "object",
  "properties": {
    "organization_merge": {
      "type": "object",
      "properties": {
        "winner_id": {
          "type": "integer",
          "required": [
            "winner_id"
          ],
          "description": "The id of the winning organization."
        }
      }
    }
  }
}
object OrganizationMergeResponse
{
  "type": "object",
  "properties": {
    "organization_merge": {
      "type": "object",
      "required": [
        "id",
        "url",
        "loser_id",
        "winner_id",
        "status"
      ],
      "properties": {
        "id": {
          "type": "string",
          "format": "string"
        },
        "url": {
          "type": "string",
          "format": "string"
        },
        "status": {
          "enum": [
            "new",
            "in_progress",
            "error",
            "complete"
          ],
          "type": "string"
        },
        "loser_id": {
          "type": "integer"
        },
        "winner_id": {
          "type": "integer"
        }
      }
    }
  }
}
object OrganizationMetadataObject
{
  "type": "object",
  "properties": {
    "users_count": {
      "type": "integer",
      "description": "The number of users for the organization"
    },
    "tickets_count": {
      "type": "integer",
      "description": "The number of tickets for the organization"
    }
  }
}
object OrganizationObject
{
  "type": "object",
  "example": {
    "id": 35436,
    "url": "https://company.zendesk.com/api/v2/organizations/35436.json",
    "name": "One Organization",
    "tags": [
      "enterprise",
      "other_tag"
    ],
    "notes": "",
    "details": "This is a kind of organization",
    "group_id": null,
    "created_at": "2009-07-20T22:55:29Z",
    "updated_at": "2011-05-05T10:38:52Z",
    "external_id": "ABC123",
    "domain_names": [
      "example.com",
      "test.com"
    ],
    "shared_tickets": true,
    "shared_comments": true,
    "organization_fields": {
      "org_decimal": 5.2,
      "org_dropdown": "option_1"
    }
  },
  "properties": {
    "id": {
      "type": "integer",
      "description": "Automatically assigned when the organization is created"
    },
    "url": {
      "type": "string",
      "description": "The API url of this organization"
    },
    "name": {
      "type": "string",
      "description": "A unique name for the organization"
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The tags of the organization"
    },
    "notes": {
      "type": "string",
      "nullable": true,
      "description": "Any notes you have about the organization"
    },
    "details": {
      "type": "string",
      "nullable": true,
      "description": "Any details obout the organization, such as the address"
    },
    "group_id": {
      "type": "integer",
      "nullable": true,
      "description": "New tickets from users in this organization are automatically put in this group"
    },
    "created_at": {
      "type": "string",
      "readOnly": true,
      "description": "The time the organization was created"
    },
    "updated_at": {
      "type": "string",
      "readOnly": true,
      "description": "The time of the last update of the organization"
    },
    "external_id": {
      "type": "string",
      "nullable": true,
      "description": "A unique external id to associate organizations to an external record. The id is case-insensitive. For example, \"company1\" and \"Company1\" are considered the same"
    },
    "domain_names": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "An array of domain names associated with this organization"
    },
    "shared_tickets": {
      "type": "boolean",
      "description": "End users in this organization are able to see each other's tickets"
    },
    "shared_comments": {
      "type": "boolean",
      "description": "End users in this organization are able to comment on each other's tickets"
    },
    "organization_fields": {
      "type": "object",
      "nullable": true,
      "description": "Custom fields for this organization. See [Custom organization fields](/api-reference/ticketing/organizations/organizations/#custom-organization-fields)",
      "additionalProperties": {
        "oneOf": [
          {
            "type": "string"
          },
          {
            "type": "number"
          }
        ]
      }
    }
  }
}
object OrganizationResponse
{
  "type": "object",
  "properties": {
    "organization": {
      "$ref": "#/components/schemas/OrganizationObject"
    }
  }
}
object OrganizationSubscriptionCreateRequest
{
  "type": "object",
  "properties": {
    "organization_subscription": {
      "$ref": "#/components/schemas/OrganizationSubscriptionInput"
    }
  }
}
object OrganizationSubscriptionInput
{
  "type": "object",
  "properties": {
    "user_id": {
      "type": "integer",
      "description": "The ID of the user"
    },
    "organization_id": {
      "type": "integer",
      "description": "The ID of the organization"
    }
  }
}
object OrganizationSubscriptionObject
{
  "type": "object",
  "title": "Organization Subscriptions",
  "example": {
    "id": 1234,
    "user_id": 482,
    "created_at": "2009-07-20T22:55:29Z",
    "organization_id": 32
  },
  "properties": {
    "id": {
      "type": "integer",
      "description": "The ID of the organization subscription"
    },
    "user_id": {
      "type": "integer",
      "description": "The ID of the user"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "The date the organization subscription was created"
    },
    "organization_id": {
      "type": "integer",
      "description": "The ID of the organization"
    }
  }
}
object OrganizationSubscriptionResponse
{
  "type": "object",
  "properties": {
    "organization_subscription": {
      "$ref": "#/components/schemas/OrganizationSubscriptionObject"
    }
  }
}
object OrganizationSubscriptionsResponse
{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/OffsetPaginationObject"
    },
    {
      "type": "object",
      "properties": {
        "organization_subscriptions": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/OrganizationSubscriptionObject"
          },
          "description": "An array of organization subscriptions"
        }
      }
    }
  ]
}
object OrganizationsRelatedResponse
{
  "type": "object",
  "properties": {
    "organization_related": {
      "$ref": "#/components/schemas/OrganizationMetadataObject"
    }
  }
}
object OrganizationsResponse
{
  "type": "object",
  "properties": {
    "count": {
      "type": "integer"
    },
    "next_page": {
      "type": "string",
      "nullable": true
    },
    "organizations": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/OrganizationObject"
      }
    },
    "previous_page": {
      "type": "string",
      "nullable": true
    }
  }
}
object Pagination
{
  "type": "object",
  "properties": {
    "meta": {
      "type": "object",
      "properties": {
        "has_more": {
          "type": "boolean"
        },
        "after_cursor": {
          "type": "string"
        },
        "before_cursor": {
          "type": "string"
        }
      }
    },
    "links": {
      "type": "object",
      "properties": {
        "next": {
          "type": "string"
        },
        "prev": {
          "type": "string"
        }
      }
    }
  }
}
string PushNotificationDevicesBulkUnregisterResponse
{
  "type": "string",
  "example": "",
  "description": "empty"
}
array PushNotificationDevicesInput
{
  "type": "array",
  "items": {
    "type": "string",
    "description": "Mobile device token"
  }
}
object PushNotificationDevicesRequest
{
  "type": "object",
  "properties": {
    "push_notification_devices": {
      "$ref": "#/components/schemas/PushNotificationDevicesInput"
    }
  }
}
object QueueObject
{
  "type": "object",
  "example": {
    "id": "01HG80ATNNZK1N7XRFVKX48XD6",
    "url": "https://company.zendesk.com/api/v2/queues/01HG80ATNNZK1N7XRFVKX48XD6.json",
    "name": "New queue with valid definition",
    "order": 1,
    "priority": 1,
    "created_at": "2023-11-27T09:03:59Z",
    "definition": {
      "all": [
        {
          "field": "priority",
          "value": "urgent",
          "operator": "is"
        }
      ],
      "any": []
    },
    "updated_at": "2023-11-27T09:03:59Z",
    "description": "Queue description",
    "primary_groups": {
      "count": 2,
      "groups": [
        {
          "id": 6784729637757,
          "name": "EWR"
        },
        {
          "id": 5399674286077,
          "name": "test"
        }
      ]
    },
    "secondary_groups": {
      "count": 0,
      "groups": []
    }
  },
  "properties": {
    "id": {
      "type": "string",
      "readOnly": true,
      "description": "Automatically assigned when creating queue"
    },
    "url": {
      "type": "string",
      "readOnly": true,
      "description": "The API URL of the queue"
    },
    "name": {
      "type": "string",
      "description": "The name of the queue"
    },
    "order": {
      "type": "integer",
      "description": "The queue-applied order"
    },
    "priority": {
      "type": "integer",
      "description": "The queue-applied priority"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true,
      "description": "The time the queue was created"
    },
    "definition": {
      "type": "object",
      "properties": {
        "all": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "field": {
                "type": "string"
              },
              "value": {
                "type": "string"
              },
              "operator": {
                "type": "string"
              }
            }
          }
        },
        "any": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "field": {
                "type": "string"
              },
              "value": {
                "type": "string"
              },
              "operator": {
                "type": "string"
              }
            }
          }
        }
      },
      "description": "Conditions when queue could be applied"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true,
      "description": "The time of the queue's last update"
    },
    "description": {
      "type": "string",
      "description": "The description of the queue"
    },
    "primary_groups": {
      "type": "object",
      "properties": {
        "count": {
          "type": "integer"
        },
        "groups": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "integer"
              },
              "name": {
                "type": "string"
              }
            }
          }
        }
      },
      "description": "Primary group ids linked to the queue"
    },
    "secondary_groups": {
      "type": "object",
      "properties": {
        "count": {
          "type": "integer"
        },
        "groups": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "integer"
              },
              "name": {
                "type": "string"
              }
            }
          }
        }
      },
      "description": "Secondary group ids linked to the queue"
    }
  }
}
object QueueResponse
{
  "type": "object",
  "properties": {
    "queue": {
      "$ref": "#/components/schemas/QueueObject"
    }
  }
}
object QueuesResponse
{
  "type": "object",
  "properties": {
    "queues": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/QueueObject"
      }
    }
  }
}
object RecoverSuspendedTicketResponse
{
  "type": "object",
  "properties": {
    "ticket": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SuspendedTicketObject"
      }
    }
  }
}
object RecoverSuspendedTicketUnprocessableContentResponse
{
  "type": "object",
  "properties": {
    "ticket": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SuspendedTicketObject"
      }
    }
  }
}
object RecoverSuspendedTicketsResponse
{
  "type": "object",
  "properties": {
    "tickets": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SuspendedTicketObject"
      }
    }
  }
}
object RelationshipFilterDefinition
{
  "type": "object",
  "properties": {
    "conditions_all": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TriggerConditionDefinitionObjectAll"
      }
    },
    "conditions_any": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TriggerConditionDefinitionObjectAny"
      }
    }
  }
}
object RelationshipFilterDefinitionResponse
{
  "type": "object",
  "properties": {
    "definitions": {
      "$ref": "#/components/schemas/RelationshipFilterDefinition"
    }
  }
}
object RenewSessionResponse
{
  "type": "object",
  "properties": {
    "authenticity_token": {
      "type": "string",
      "description": "A token of authenticity for the request"
    }
  }
}
object RequestObject
{
  "type": "object",
  "example": {
    "id": 35436,
    "url": "https://company.zendesk.com/api/v2/requests/35436.json",
    "via": {
      "channel": "web"
    },
    "type": "problem",
    "due_at": "2011-05-24T12:00:00Z",
    "status": "open",
    "subject": "Help, my printer is on fire!",
    "group_id": 8665,
    "priority": "normal",
    "created_at": "2009-07-20T22:55:29Z",
    "updated_at": "2011-05-05T10:38:52Z",
    "assignee_id": 72983,
    "description": "The fire is very colorful.",
    "requester_id": 1462,
    "ticket_form_id": 2,
    "organization_id": 509974,
    "collaborator_ids": [],
    "can_be_solved_by_me": false
  },
  "required": [
    "subject"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "readOnly": true,
      "description": "Automatically assigned when creating requests"
    },
    "url": {
      "type": "string",
      "readOnly": true,
      "description": "The API url of this request"
    },
    "via": {
      "$ref": "#/components/schemas/TicketAuditViaObject"
    },
    "type": {
      "type": "string",
      "description": "The type of the request, \"question\", \"incident\", \"problem\", \"task\""
    },
    "due_at": {
      "type": "string",
      "format": "date-time",
      "description": "When the task is due (only applies if the request is of type \"task\")"
    },
    "solved": {
      "type": "boolean",
      "description": "Whether or not request is solved (an end user can set this if \"can_be_solved_by_me\", above, is true for that user)"
    },
    "status": {
      "type": "string",
      "description": "The state of the request, \"new\", \"open\", \"pending\", \"hold\", \"solved\", \"closed\""
    },
    "subject": {
      "type": "string",
      "description": "The value of the subject field for this request if the subject field is visible to end users; a truncated version of the description otherwise"
    },
    "group_id": {
      "type": "integer",
      "readOnly": true,
      "description": "The id of the assigned group if the field is visible to end users"
    },
    "priority": {
      "type": "string",
      "description": "The priority of the request, \"low\", \"normal\", \"high\", \"urgent\""
    },
    "is_public": {
      "type": "boolean",
      "readOnly": true,
      "description": "Is true if any comments are public, false otherwise"
    },
    "recipient": {
      "type": "string",
      "description": "The original recipient e-mail address of the request"
    },
    "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 last got updated"
    },
    "assignee_id": {
      "type": "integer",
      "readOnly": true,
      "description": "The id of the assignee if the field is visible to end users"
    },
    "description": {
      "type": "string",
      "readOnly": true,
      "description": "Read-only first comment on the request. When [creating a request](https://developer.zendesk.com), use `comment` to set the description"
    },
    "email_cc_ids": {
      "type": "array",
      "items": {
        "type": "integer"
      },
      "readOnly": true,
      "description": "The ids of users who are currently email CCs on the ticket. See [CCs and followers resources](https://support.zendesk.com/hc/en-us/articles/360020585233) in the Support Help Center"
    },
    "requester_id": {
      "type": "integer",
      "readOnly": true,
      "description": "The id of the requester"
    },
    "custom_fields": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer"
          },
          "value": {
            "type": "string"
          }
        }
      },
      "description": "Custom fields for the request. See [Setting custom field values](/api-reference/ticketing/tickets/tickets/#setting-custom-field-values) in the Tickets doc"
    },
    "ticket_form_id": {
      "type": "integer",
      "description": "The numeric id of the ticket form associated with this request if the form is visible to end users - only applicable for enterprise accounts"
    },
    "organization_id": {
      "type": "integer",
      "readOnly": true,
      "description": "The organization of the requester"
    },
    "collaborator_ids": {
      "type": "array",
      "items": {
        "type": "integer"
      },
      "readOnly": true,
      "description": "The ids of users currently CC'ed on the ticket"
    },
    "custom_status_id": {
      "type": "integer",
      "description": "The custom ticket status id of the ticket"
    },
    "followup_source_id": {
      "type": "integer",
      "readOnly": true,
      "description": "The id of the original ticket if this request is a follow-up ticket. See [Create Request](https://developer.zendesk.com)"
    },
    "can_be_solved_by_me": {
      "type": "boolean",
      "readOnly": true,
      "description": "If true, an end user can mark the request as solved. See [Update Request](/api-reference/ticketing/tickets/ticket-requests/#update-request)"
    }
  }
}
object RequestResponse
{
  "type": "object",
  "properties": {
    "request": {
      "$ref": "#/components/schemas/RequestObject"
    }
  }
}
object RequestsResponse
{
  "type": "object",
  "properties": {
    "requests": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/RequestObject"
      }
    }
  }
}
object ResellerCheckSubdomainAvailabilityResponse
{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    }
  }
}
object ResourceCollectionObject
{
  "type": "object",
  "example": {
    "id": 35436,
    "resources": [
      {
        "type": "triggers",
        "deleted": false,
        "identifier": "email_on_ticket_solved",
        "resource_id": 10824486485524
      },
      {
        "type": "ticket_fields",
        "deleted": false,
        "identifier": "support_description",
        "resource_id": 10824486482580
      }
    ],
    "created_at": "2011-07-20T22:55:29Z",
    "updated_at": "2011-07-20T22:55:29Z"
  },
  "properties": {
    "id": {
      "type": "integer",
      "readOnly": true,
      "description": "id for the resource collection. Automatically assigned upon creation"
    },
    "resources": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string"
          },
          "deleted": {
            "type": "boolean"
          },
          "identifier": {
            "type": "string"
          },
          "resource_id": {
            "type": "integer"
          }
        }
      },
      "readOnly": true,
      "description": "Array of resource metadata objects. See [Resource objects](https://developer.zendesk.com)"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true,
      "description": "When the resource collection was created"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true,
      "description": "Last time the resource collection was updated"
    }
  }
}
object ResourceCollectionResponse
{
  "type": "object",
  "properties": {
    "resource_collection": {
      "$ref": "#/components/schemas/ResourceCollectionObject"
    }
  }
}
object ResourceCollectionsResponse
{
  "type": "object",
  "properties": {
    "count": {
      "type": "integer",
      "readOnly": true
    },
    "next_page": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    },
    "previous_page": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    },
    "resource_collections": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ResourceCollectionObject"
      }
    }
  }
}
object ReverseLookupResponse
{
  "type": "object",
  "anyOf": [
    {
      "$ref": "#/components/schemas/UsersResponse"
    }
  ]
}
object SLAPoliciesResponse
{
  "type": "object",
  "properties": {
    "count": {
      "type": "integer",
      "readOnly": true
    },
    "next_page": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    },
    "sla_policies": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SLAPolicyObject"
      }
    },
    "previous_page": {
      "type": "string",
      "nullable": true,
      "readOnly": true
    }
  }
}
object SLAPolicyFilterConditionObject
{
  "type": "object",
  "properties": {
    "field": {
      "type": "string",
      "description": "The name of a ticket field"
    },
    "value": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "array",
          "items": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "integer"
              }
            ]
          }
        }
      ],
      "description": "The value of a ticket field"
    },
    "operator": {
      "type": "string",
      "description": "A comparison operator"
    }
  }
}
object SLAPolicyFilterDefinitionResponse
{
  "type": "object",
  "properties": {
    "definitions": {
      "type": "object",
      "properties": {
        "all": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "group": {
                "type": "string"
              },
              "title": {
                "type": "string"
              },
              "value": {
                "type": "string"
              },
              "target": {
                "type": "string",
                "nullable": true
              },
              "values": {
                "type": "object",
                "properties": {
                  "list": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "title": {
                          "type": "string"
                        },
                        "value": {
                          "type": "string",
                          "nullable": true
                        }
                      }
                    }
                  },
                  "type": {
                    "type": "string"
                  }
                }
              },
              "operators": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "title": {
                      "type": "string"
                    },
                    "value": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        },
        "any": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "group": {
                "type": "string"
              },
              "title": {
                "type": "string"
              },
              "value": {
                "type": "string"
              },
              "target": {
                "type": "string",
                "nullable": true
              },
              "values": {
                "type": "object",
                "properties": {
                  "list": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "title": {
                          "type": "string"
                        },
                        "value": {
                          "type": "string",
                          "nullable": true
                        }
                      }
                    }
                  },
                  "type": {
                    "type": "string"
                  }
                }
              },
              "operators": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "title": {
                      "type": "string"
                    },
                    "value": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}
object SLAPolicyFilterObject
{
  "type": "object",
  "properties": {
    "all": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SLAPolicyFilterConditionObject"
      }
    },
    "any": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SLAPolicyFilterConditionObject"
      }
    }
  },
  "description": "An object that describes the conditions that a ticket must match in order for an SLA policy to be applied to that ticket. See [Filter](https://developer.zendesk.com)."
}
object SLAPolicyMetricObject
{
  "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"
    }
  }
}
object SLAPolicyObject
{
  "type": "object",
  "example": {
    "id": 25,
    "url": "https://company.zendesk.com/api/v2/slas/policies/25.json",
    "title": "Silver Plan",
    "filter": {
      "all": [
        {
          "field": "type",
          "value": "incident",
          "operator": "is"
        },
        {
          "field": "via_id",
          "value": "4",
          "operator": "is"
        },
        {
          "field": "custom_status_id",
          "value": [
            "1",
            "2"
          ],
          "operator": "includes"
        }
      ],
      "any": []
    },
    "position": 3,
    "created_at": "2015-03-17T22:50:26Z",
    "updated_at": "2015-03-17T22:50:26Z",
    "description": "Organizations: Silver Plan",
    "policy_metrics": [
      {
        "metric": "first_reply_time",
        "target": 60,
        "priority": "low",
        "business_hours": false
      }
    ]
  },
  "required": [
    "title",
    "filter"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "readOnly": true,
      "description": "Automatically assigned when created"
    },
    "url": {
      "type": "string",
      "readOnly": true,
      "description": "URL of the SLA Policy reacord"
    },
    "title": {
      "type": "string",
      "description": "The title of the SLA policy"
    },
    "filter": {
      "$ref": "#/components/schemas/SLAPolicyFilterObject"
    },
    "position": {
      "type": "integer",
      "description": "Position of the SLA policy that determines the order they will be matched. If not specified, the SLA policy is added as the last position"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true,
      "description": "The time the SLA policy was created"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true,
      "description": "The time of the last update of the SLA policy"
    },
    "description": {
      "type": "string",
      "description": "The description of the SLA policy"
    },
    "policy_metrics": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SLAPolicyMetricObject"
      },
      "description": "Array of [Policy Metric](https://developer.zendesk.com) objects"
    }
  }
}
object SLAPolicyResponse
{
  "type": "object",
  "properties": {
    "sla_policy": {
      "$ref": "#/components/schemas/SLAPolicyObject"
    }
  }
}
object SatisfactionRatingObject
{
  "type": "object",
  "example": {
    "id": 35436,
    "url": "https://company.zendesk.com/api/v2/satisfaction_ratings/62.json",
    "score": "good",
    "group_id": 44,
    "ticket_id": 208,
    "created_at": "2011-07-20T22:55:29Z",
    "updated_at": "2011-07-20T22:55:29Z",
    "assignee_id": 135,
    "requester_id": 7881
  },
  "required": [
    "assignee_id",
    "group_id",
    "requester_id",
    "ticket_id",
    "score"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "readOnly": true,
      "description": "Automatically assigned upon creation"
    },
    "url": {
      "type": "string",
      "readOnly": true,
      "description": "The API url of this rating"
    },
    "score": {
      "type": "string",
      "description": "The rating \"offered\", \"unoffered\", \"good\" or \"bad\""
    },
    "reason": {
      "type": "string",
      "description": "The reason for a bad rating given by the requester in a follow-up question. Satisfaction reasons must be [enabled](https://support.zendesk.com/hc/en-us/articles/223152967)"
    },
    "comment": {
      "type": "string",
      "description": "The comment received with this rating, if available"
    },
    "group_id": {
      "type": "integer",
      "readOnly": true,
      "description": "The id of group assigned to at the time of rating"
    },
    "reason_id": {
      "type": "integer",
      "description": "id for the reason the user gave a negative rating. Can only be set on ratings with a `score` of \"bad\". To get a descriptive value for the id, use the [Show Reason for Satisfaction Rating](/api-reference/ticketing/ticket-management/satisfaction_reasons/#show-reason-for-satisfaction-rating) endpoint"
    },
    "ticket_id": {
      "type": "integer",
      "readOnly": true,
      "description": "The id of ticket being rated"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true,
      "description": "The time the satisfaction rating got created"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true,
      "description": "The time the satisfaction rating got updated"
    },
    "assignee_id": {
      "type": "integer",
      "readOnly": true,
      "description": "The id of agent assigned to at the time of rating"
    },
    "reason_code": {
      "type": "integer",
      "description": "The default reasons the user can select from a list menu for giving a negative rating. See [Reason codes](/api-reference/ticketing/ticket-management/satisfaction_reasons/#reason-codes) in the Satisfaction Reasons API. Can only be set on ratings with a `score` of \"bad\". Responses don't include this property"
    },
    "requester_id": {
      "type": "integer",
      "readOnly": true,
      "description": "The id of ticket requester submitting the rating"
    }
  }
}
object SatisfactionRatingResponse
{
  "type": "object",
  "properties": {
    "satisfaction_rating": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SatisfactionRatingObject"
      }
    }
  }
}
object SatisfactionRatingsCountResponse
{
  "type": "object",
  "properties": {
    "count": {
      "type": "object",
      "properties": {
        "value": {
          "type": "integer"
        },
        "refreshed_at": {
          "type": "string",
          "format": "date-time"
        }
      }
    }
  }
}
Load more schemas