openapi: 3.0.0 info: contact: email: hello@unified.to url: https://unified.to/contact description: One API to Rule Them All termsOfService: https://unified.to/tos title: Unified.to account ticketing API version: '1.0' servers: - description: North American data region url: https://api.unified.to - description: European data region url: https://api-eu.unified.to - description: Australian data region url: https://api-au.unified.to security: - jwt: [] tags: - name: ticketing paths: /ticketing/{connection_id}/category: get: operationId: listTicketingCategories parameters: - in: query name: limit required: false schema: type: number - in: query name: offset required: false schema: type: number - description: Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) in: query name: updated_gte required: false schema: type: string - in: query name: sort required: false schema: type: string - in: query name: order required: false schema: type: string - description: Query string to search. eg. email address or name in: query name: query required: false schema: type: string - description: The parent ID to filter by in: query name: parent_id required: false schema: type: string - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - description - is_active - parent_id - raw type: string type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/TicketingCategories' description: Successful security: - jwt: [] summary: List All Categories tags: - ticketing post: operationId: createTicketingCategory parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - description - is_active - parent_id - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/TicketingCategory' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/TicketingCategory' description: Successful security: - jwt: [] summary: Create a Category tags: - ticketing /ticketing/{connection_id}/category/{id}: delete: operationId: removeTicketingCategory parameters: - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Category in: path name: id required: true schema: type: string responses: '200': description: Successful default: content: {} description: Successful headers: Content-Type: required: false schema: type: string security: - jwt: [] summary: Remove a Category tags: - ticketing get: operationId: getTicketingCategory parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - description - is_active - parent_id - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Category in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/TicketingCategory' description: Successful security: - jwt: [] summary: Retrieve a Category tags: - ticketing patch: operationId: patchTicketingCategory parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - description - is_active - parent_id - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Category in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/TicketingCategory' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/TicketingCategory' description: Successful security: - jwt: [] summary: Update a Category tags: - ticketing put: operationId: updateTicketingCategory parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - description - is_active - parent_id - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Category in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/TicketingCategory' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/TicketingCategory' description: Successful security: - jwt: [] summary: Update a Category tags: - ticketing /ticketing/{connection_id}/customer: get: operationId: listTicketingCustomers parameters: - in: query name: limit required: false schema: type: number - in: query name: offset required: false schema: type: number - description: Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) in: query name: updated_gte required: false schema: type: string - in: query name: sort required: false schema: type: string - in: query name: order required: false schema: type: string - description: Query string to search. eg. email address or name in: query name: query required: false schema: type: string - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - emails - telephones - tags - raw type: string type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/TicketingCustomers' description: Successful security: - jwt: [] summary: List All Customers tags: - ticketing post: operationId: createTicketingCustomer parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - emails - telephones - tags - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/TicketingCustomer' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/TicketingCustomer' description: Successful security: - jwt: [] summary: Create a Customer tags: - ticketing /ticketing/{connection_id}/customer/{id}: delete: operationId: removeTicketingCustomer parameters: - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Customer in: path name: id required: true schema: type: string responses: '200': description: Successful default: content: {} description: Successful headers: Content-Type: required: false schema: type: string security: - jwt: [] summary: Remove a Customer tags: - ticketing get: operationId: getTicketingCustomer parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - emails - telephones - tags - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Customer in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/TicketingCustomer' description: Successful security: - jwt: [] summary: Retrieve a Customer tags: - ticketing patch: operationId: patchTicketingCustomer parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - emails - telephones - tags - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Customer in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/TicketingCustomer' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/TicketingCustomer' description: Successful security: - jwt: [] summary: Update a Customer tags: - ticketing put: operationId: updateTicketingCustomer parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - emails - telephones - tags - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Customer in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/TicketingCustomer' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/TicketingCustomer' description: Successful security: - jwt: [] summary: Update a Customer tags: - ticketing /ticketing/{connection_id}/note: get: operationId: listTicketingNotes parameters: - in: query name: limit required: false schema: type: number - in: query name: offset required: false schema: type: number - description: Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) in: query name: updated_gte required: false schema: type: string - in: query name: sort required: false schema: type: string - in: query name: order required: false schema: type: string - description: Query string to search. eg. email address or name in: query name: query required: false schema: type: string - description: The ticket ID to filter by in: query name: ticket_id required: false schema: type: string - description: The customer ID to filter by in: query name: customer_id required: false schema: type: string - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - customer_id - description - ticket_id - user_id - raw type: string type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/TicketingNotes' description: Successful security: - jwt: [] summary: List All Notes tags: - ticketing post: operationId: createTicketingNote parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - customer_id - description - ticket_id - user_id - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/TicketingNote' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/TicketingNote' description: Successful security: - jwt: [] summary: Create a Note tags: - ticketing /ticketing/{connection_id}/note/{id}: delete: operationId: removeTicketingNote parameters: - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Note in: path name: id required: true schema: type: string responses: '200': description: Successful default: content: {} description: Successful headers: Content-Type: required: false schema: type: string security: - jwt: [] summary: Remove a Note tags: - ticketing get: operationId: getTicketingNote parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - customer_id - description - ticket_id - user_id - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Note in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/TicketingNote' description: Successful security: - jwt: [] summary: Retrieve a Note tags: - ticketing patch: operationId: patchTicketingNote parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - customer_id - description - ticket_id - user_id - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Note in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/TicketingNote' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/TicketingNote' description: Successful security: - jwt: [] summary: Update a Note tags: - ticketing put: operationId: updateTicketingNote parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - customer_id - description - ticket_id - user_id - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Note in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/TicketingNote' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/TicketingNote' description: Successful security: - jwt: [] summary: Update a Note tags: - ticketing /ticketing/{connection_id}/ticket: get: operationId: listTicketingTickets parameters: - in: query name: limit required: false schema: type: number - in: query name: offset required: false schema: type: number - description: Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) in: query name: updated_gte required: false schema: type: string - in: query name: sort required: false schema: type: string - in: query name: order required: false schema: type: string - description: Query string to search. eg. email address or name in: query name: query required: false schema: type: string - description: The customer ID to filter by in: query name: customer_id required: false schema: type: string - description: The user/employee ID to filter by (reference to HrisEmployee) in: query name: user_id required: false schema: type: string - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - customer_id - subject - description - status - closed_at - priority - category_id - category - source - source_ref - tags - user_id - url - raw type: string type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/TicketingTickets' description: Successful security: - jwt: [] summary: List All Tickets tags: - ticketing post: operationId: createTicketingTicket parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - customer_id - subject - description - status - closed_at - priority - category_id - category - source - source_ref - tags - user_id - url - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/TicketingTicket' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/TicketingTicket' description: Successful security: - jwt: [] summary: Create a Ticket tags: - ticketing /ticketing/{connection_id}/ticket/{id}: delete: operationId: removeTicketingTicket parameters: - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Ticket in: path name: id required: true schema: type: string responses: '200': description: Successful default: content: {} description: Successful headers: Content-Type: required: false schema: type: string security: - jwt: [] summary: Remove a Ticket tags: - ticketing get: operationId: getTicketingTicket parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - customer_id - subject - description - status - closed_at - priority - category_id - category - source - source_ref - tags - user_id - url - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Ticket in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/TicketingTicket' description: Successful security: - jwt: [] summary: Retrieve a Ticket tags: - ticketing patch: operationId: patchTicketingTicket parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - customer_id - subject - description - status - closed_at - priority - category_id - category - source - source_ref - tags - user_id - url - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Ticket in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/TicketingTicket' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/TicketingTicket' description: Successful security: - jwt: [] summary: Update a Ticket tags: - ticketing put: operationId: updateTicketingTicket parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - customer_id - subject - description - status - closed_at - priority - category_id - category - source - source_ref - tags - user_id - url - raw type: string type: array type: array - description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar' in: query name: raw required: false schema: type: string - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Ticket in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/TicketingTicket' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/TicketingTicket' description: Successful security: - jwt: [] summary: Update a Ticket tags: - ticketing components: schemas: TicketingNotes: items: $ref: '#/components/schemas/TicketingNote' type: array TicketingTicket: properties: category: type: string category_id: type: string closed_at: format: date-time type: string created_at: format: date-time type: string customer_id: type: string description: type: string id: type: string priority: type: string raw: additionalProperties: true type: object source: type: string source_ref: type: string status: enum: - ACTIVE - CLOSED type: string x-speakeasy-unknown-values: allow subject: type: string tags: $ref: '#/components/schemas/property_TicketingTicket_tags' updated_at: format: date-time type: string url: type: string user_id: type: string type: object TicketingCategories: items: $ref: '#/components/schemas/TicketingCategory' type: array property_TicketingCustomer_telephones: items: $ref: '#/components/schemas/TicketingTelephone' type: array TicketingCategory: properties: created_at: format: date-time type: string description: type: string id: type: string is_active: type: boolean name: type: string parent_id: type: string raw: additionalProperties: true type: object updated_at: format: date-time type: string type: object TicketingCustomer: properties: created_at: format: date-time type: string emails: $ref: '#/components/schemas/property_TicketingCustomer_emails' id: type: string name: type: string raw: additionalProperties: true type: object tags: $ref: '#/components/schemas/property_TicketingCustomer_tags' telephones: $ref: '#/components/schemas/property_TicketingCustomer_telephones' updated_at: format: date-time type: string type: object property_TicketingTicket_tags: items: type: string type: array TicketingEmail: properties: email: type: string type: enum: - WORK - HOME - OTHER type: string x-speakeasy-unknown-values: allow required: - email type: object TicketingNote: properties: created_at: format: date-time type: string customer_id: type: string description: type: string id: type: string raw: additionalProperties: true type: object ticket_id: type: string updated_at: format: date-time type: string user_id: type: string type: object TicketingCustomers: items: $ref: '#/components/schemas/TicketingCustomer' type: array property_TicketingCustomer_tags: items: type: string type: array TicketingTelephone: properties: telephone: type: string type: enum: - WORK - HOME - OTHER - FAX - MOBILE type: string x-speakeasy-unknown-values: allow required: - telephone type: object property_TicketingCustomer_emails: items: $ref: '#/components/schemas/TicketingEmail' type: array TicketingTickets: items: $ref: '#/components/schemas/TicketingTicket' type: array securitySchemes: jwt: in: header name: authorization type: apiKey externalDocs: description: API Documentation url: https://docs.unified.to