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 document 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: document paths: /ats/{connection_id}/document: get: operationId: listAtsDocuments 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 application ID to filter by in: query name: application_id required: false schema: type: string - description: The candidate ID to filter by in: query name: candidate_id required: false schema: type: string - description: The job ID to filter by in: query name: job_id required: false schema: type: string - description: The type to filter by in: query name: type required: false schema: type: string - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - document_url - document_data - filename - type - candidate_id - application_id - job_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/AtsDocuments' description: Successful security: - jwt: [] summary: List all documents tags: - document post: operationId: createAtsDocument parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - document_url - document_data - filename - type - candidate_id - application_id - job_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/AtsDocument' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AtsDocument' description: Successful security: - jwt: [] summary: Create a document tags: - document /ats/{connection_id}/document/{id}: delete: operationId: removeAtsDocument parameters: - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Document 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 document tags: - document get: operationId: getAtsDocument parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - document_url - document_data - filename - type - candidate_id - application_id - job_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 Document in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/AtsDocument' description: Successful security: - jwt: [] summary: Retrieve a document tags: - document patch: operationId: patchAtsDocument parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - document_url - document_data - filename - type - candidate_id - application_id - job_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 Document in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AtsDocument' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AtsDocument' description: Successful security: - jwt: [] summary: Update a document tags: - document put: operationId: updateAtsDocument parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - document_url - document_data - filename - type - candidate_id - application_id - job_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 Document in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AtsDocument' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AtsDocument' description: Successful security: - jwt: [] summary: Update a document tags: - document /signing/{connection_id}/document: get: operationId: listSigningDocuments 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 status to filter by in: query name: status required: false schema: type: string - description: The signing template ID to filter by in: query name: template_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 - status - sent_at - completed_at - expires_at - template_id - download_url - creator_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/SigningDocuments' description: Successful security: - jwt: [] summary: List All Documents tags: - document post: operationId: createSigningDocument parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - description - status - sent_at - completed_at - expires_at - template_id - download_url - creator_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/SigningDocument' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/SigningDocument' description: Successful security: - jwt: [] summary: Create a Document tags: - document /signing/{connection_id}/document/{id}: delete: operationId: removeSigningDocument parameters: - description: ID of the connection in: path name: connection_id required: true schema: type: string - description: ID of the Document 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 Document tags: - document get: operationId: getSigningDocument parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - description - status - sent_at - completed_at - expires_at - template_id - download_url - creator_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 Document in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/SigningDocument' description: Successful security: - jwt: [] summary: Retrieve a Document tags: - document patch: operationId: patchSigningDocument parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - description - status - sent_at - completed_at - expires_at - template_id - download_url - creator_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 Document in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SigningDocument' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/SigningDocument' description: Successful security: - jwt: [] summary: Update a Document tags: - document put: operationId: updateSigningDocument parameters: - description: Fields to return in: query name: fields required: false schema: items: enum: - id - created_at - updated_at - name - description - status - sent_at - completed_at - expires_at - template_id - download_url - creator_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 Document in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SigningDocument' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/SigningDocument' description: Successful security: - jwt: [] summary: Update a Document tags: - document components: schemas: AtsDocuments: items: $ref: '#/components/schemas/AtsDocument' type: array SigningDocument: properties: completed_at: format: date-time type: string created_at: format: date-time type: string creator_id: type: string description: type: string download_url: type: string expires_at: format: date-time type: string id: type: string name: type: string raw: additionalProperties: true type: object sent_at: format: date-time type: string status: enum: - DRAFT - SENT - DELIVERED - IN_PROGRESS - COMPLETED - DECLINED - VOIDED - EXPIRED type: string x-speakeasy-unknown-values: allow template_id: type: string updated_at: format: date-time type: string type: object SigningDocuments: items: $ref: '#/components/schemas/SigningDocument' type: array AtsDocument: properties: application_id: type: string candidate_id: type: string created_at: format: date-time type: string document_data: type: string document_url: type: string filename: type: string id: type: string job_id: type: string raw: additionalProperties: true type: object type: enum: - RESUME - COVER_LETTER - OFFER_PACKET - OFFER_LETTER - TAKE_HOME_TEST - OTHER type: string x-speakeasy-unknown-values: allow updated_at: format: date-time type: string user_id: type: string type: object securitySchemes: jwt: in: header name: authorization type: apiKey externalDocs: description: API Documentation url: https://docs.unified.to