Unified.to API: One API to Rule Them All

• SDK Installation
• SDK Example Usage
• Available Resources and Operations
• Server Selection

The SDK can be installed using RubyGems:

gem install specific_install
gem specific_install https://github.com/unified-to/unified-ruby-sdk 

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.accounting.create_accounting_account(connection_id="<value>", accounting_account=::UnifiedRubySDK::Shared::AccountingAccount.new(), fields_=[
    "<value>",
  ])

if ! res.accounting_account.nil?
  # handle response
end

• create_accounting_account - Create an account
• create_accounting_contact - Create a contact
• create_accounting_invoice - Create an invoice
• create_accounting_journal - Create a journal
• create_accounting_taxrate - Create a taxrate
• create_accounting_transaction - Create a transaction
• get_accounting_account - Retrieve an account
• get_accounting_contact - Retrieve a contact
• get_accounting_invoice - Retrieve an invoice
• get_accounting_journal - Retrieve a journal
• get_accounting_organization - Retrieve an organization
• get_accounting_taxrate - Retrieve a taxrate
• get_accounting_transaction - Retrieve a transaction
• list_accounting_accounts - List all accounts
• list_accounting_contacts - List all contacts
• list_accounting_invoices - List all invoices
• list_accounting_journals - List all journals
• list_accounting_organizations - List all organizations
• list_accounting_taxrates - List all taxrates
• list_accounting_transactions - List all transactions
• patch_accounting_account - Update an account
• patch_accounting_contact - Update a contact
• patch_accounting_invoice - Update an invoice
• patch_accounting_journal - Update a journal
• patch_accounting_taxrate - Update a taxrate
• patch_accounting_transaction - Update a transaction
• remove_accounting_account - Remove an account
• remove_accounting_contact - Remove a contact
• remove_accounting_invoice - Remove an invoice
• remove_accounting_journal - Remove a journal
• remove_accounting_taxrate - Remove a taxrate
• remove_accounting_transaction - Remove a transaction
• update_accounting_account - Update an account
• update_accounting_contact - Update a contact
• update_accounting_invoice - Update an invoice
• update_accounting_journal - Update a journal
• update_accounting_taxrate - Update a taxrate
• update_accounting_transaction - Update a transaction

• create_accounting_account - Create an account
• get_accounting_account - Retrieve an account
• list_accounting_accounts - List all accounts
• patch_accounting_account - Update an account
• remove_accounting_account - Remove an account
• update_accounting_account - Update an account

• create_accounting_contact - Create a contact
• create_crm_contact - Create a contact
• create_uc_contact - Create a contact
• get_accounting_contact - Retrieve a contact
• get_crm_contact - Retrieve a contact
• get_uc_contact - Retrieve a contact
• list_accounting_contacts - List all contacts
• list_crm_contacts - List all contacts
• list_uc_contacts - List all contacts
• patch_accounting_contact - Update a contact
• patch_crm_contact - Update a contact
• patch_uc_contact - Update a contact
• remove_accounting_contact - Remove a contact
• remove_crm_contact - Remove a contact
• remove_uc_contact - Remove a contact
• update_accounting_contact - Update a contact
• update_crm_contact - Update a contact
• update_uc_contact - Update a contact

• create_accounting_invoice - Create an invoice
• get_accounting_invoice - Retrieve an invoice
• list_accounting_invoices - List all invoices
• patch_accounting_invoice - Update an invoice
• remove_accounting_invoice - Remove an invoice
• update_accounting_invoice - Update an invoice

• create_accounting_journal - Create a journal
• get_accounting_journal - Retrieve a journal
• list_accounting_journals - List all journals
• patch_accounting_journal - Update a journal
• remove_accounting_journal - Remove a journal
• update_accounting_journal - Update a journal

• get_accounting_organization - Retrieve an organization
• list_accounting_organizations - List all organizations

• create_accounting_taxrate - Create a taxrate
• get_accounting_taxrate - Retrieve a taxrate
• list_accounting_taxrates - List all taxrates
• patch_accounting_taxrate - Update a taxrate
• remove_accounting_taxrate - Remove a taxrate
• update_accounting_taxrate - Update a taxrate

• create_accounting_transaction - Create a transaction
• get_accounting_transaction - Retrieve a transaction
• list_accounting_transactions - List all transactions
• patch_accounting_transaction - Update a transaction
• remove_accounting_transaction - Remove a transaction
• update_accounting_transaction - Update a transaction

• create_ats_activity - Create an activity
• create_ats_application - Create an application
• create_ats_candidate - Create a candidate
• create_ats_document - Create a document
• create_ats_interview - Create an interview
• create_ats_job - Create a job
• create_ats_scorecard - Create a scorecard
• get_ats_activity - Retrieve an activity
• get_ats_application - Retrieve an application
• get_ats_candidate - Retrieve a candidate
• get_ats_company - Retrieve a company
• get_ats_document - Retrieve a document
• get_ats_interview - Retrieve an interview
• get_ats_job - Retrieve a job
• get_ats_scorecard - Retrieve a scorecard
• list_ats_activities - List all activities
• list_ats_applications - List all applications
• list_ats_applicationstatuses - List all applicationstatuses
• list_ats_candidates - List all candidates
• list_ats_companies - List all companies
• list_ats_documents - List all documents
• list_ats_interviews - List all interviews
• list_ats_jobs - List all jobs
• list_ats_scorecards - List all scorecards
• patch_ats_activity - Update an activity
• patch_ats_application - Update an application
• patch_ats_candidate - Update a candidate
• patch_ats_document - Update a document
• patch_ats_interview - Update an interview
• patch_ats_job - Update a job
• patch_ats_scorecard - Update a scorecard
• remove_ats_activity - Remove an activity
• remove_ats_application - Remove an application
• remove_ats_candidate - Remove a candidate
• remove_ats_document - Remove a document
• remove_ats_interview - Remove an interview
• remove_ats_job - Remove a job
• remove_ats_scorecard - Remove a scorecard
• update_ats_activity - Update an activity
• update_ats_application - Update an application
• update_ats_candidate - Update a candidate
• update_ats_document - Update a document
• update_ats_interview - Update an interview
• update_ats_job - Update a job
• update_ats_scorecard - Update a scorecard

• create_ats_activity - Create an activity
• get_ats_activity - Retrieve an activity
• list_ats_activities - List all activities
• patch_ats_activity - Update an activity
• remove_ats_activity - Remove an activity
• update_ats_activity - Update an activity

• create_ats_application - Create an application
• get_ats_application - Retrieve an application
• list_ats_applications - List all applications
• patch_ats_application - Update an application
• remove_ats_application - Remove an application
• update_ats_application - Update an application

• list_ats_applicationstatuses - List all applicationstatuses

• create_ats_candidate - Create a candidate
• get_ats_candidate - Retrieve a candidate
• list_ats_candidates - List all candidates
• patch_ats_candidate - Update a candidate
• remove_ats_candidate - Remove a candidate
• update_ats_candidate - Update a candidate

• create_crm_company - Create a company
• create_hris_company - Create a company
• get_ats_company - Retrieve a company
• get_crm_company - Retrieve a company
• get_hris_company - Retrieve a company
• list_ats_companies - List all companies
• list_crm_companies - List all companies
• list_enrich_companies - Retrieve enrichment information for a company
• list_hris_companies - List all companies
• patch_crm_company - Update a company
• patch_hris_company - Update a company
• remove_crm_company - Remove a company
• remove_hris_company - Remove a company
• update_crm_company - Update a company
• update_hris_company - Update a company

• create_ats_document - Create a document
• get_ats_document - Retrieve a document
• list_ats_documents - List all documents
• patch_ats_document - Update a document
• remove_ats_document - Remove a document
• update_ats_document - Update a document

• create_ats_interview - Create an interview
• get_ats_interview - Retrieve an interview
• list_ats_interviews - List all interviews
• patch_ats_interview - Update an interview
• remove_ats_interview - Remove an interview
• update_ats_interview - Update an interview

• create_ats_job - Create a job
• get_ats_job - Retrieve a job
• list_ats_jobs - List all jobs
• patch_ats_job - Update a job
• remove_ats_job - Remove a job
• update_ats_job - Update a job

• create_ats_scorecard - Create a scorecard
• get_ats_scorecard - Retrieve a scorecard
• list_ats_scorecards - List all scorecards
• patch_ats_scorecard - Update a scorecard
• remove_ats_scorecard - Remove a scorecard
• update_ats_scorecard - Update a scorecard

• create_commerce_collection - Create a collection
• create_commerce_inventory - Create an inventory
• create_commerce_item - Create an item
• create_commerce_location - Create a location
• get_commerce_collection - Retrieve a collection
• get_commerce_inventory - Retrieve an inventory
• get_commerce_item - Retrieve an item
• get_commerce_location - Retrieve a location
• list_commerce_collections - List all collections
• list_commerce_inventories - List all inventories
• list_commerce_items - List all items
• list_commerce_locations - List all locations
• patch_commerce_collection - Update a collection
• patch_commerce_inventory - Update an inventory
• patch_commerce_item - Update an item
• patch_commerce_location - Update a location
• remove_commerce_collection - Remove a collection
• remove_commerce_inventory - Remove an inventory
• remove_commerce_item - Remove an item
• remove_commerce_location - Remove a location
• update_commerce_collection - Update a collection
• update_commerce_inventory - Update an inventory
• update_commerce_item - Update an item
• update_commerce_location - Update a location

• create_commerce_collection - Create a collection
• get_commerce_collection - Retrieve a collection
• list_commerce_collections - List all collections
• patch_commerce_collection - Update a collection
• remove_commerce_collection - Remove a collection
• update_commerce_collection - Update a collection

• create_commerce_inventory - Create an inventory
• get_commerce_inventory - Retrieve an inventory
• list_commerce_inventories - List all inventories
• patch_commerce_inventory - Update an inventory
• remove_commerce_inventory - Remove an inventory
• update_commerce_inventory - Update an inventory

• create_commerce_item - Create an item
• get_commerce_item - Retrieve an item
• list_commerce_items - List all items
• patch_commerce_item - Update an item
• remove_commerce_item - Remove an item
• update_commerce_item - Update an item

• create_commerce_location - Create a location
• create_hris_location - Create a location
• get_commerce_location - Retrieve a location
• get_hris_location - Retrieve a location
• list_commerce_locations - List all locations
• list_hris_locations - List all locations
• patch_commerce_location - Update a location
• patch_hris_location - Update a location
• remove_commerce_location - Remove a location
• remove_hris_location - Remove a location
• update_commerce_location - Update a location
• update_hris_location - Update a location

• create_crm_company - Create a company
• create_crm_contact - Create a contact
• create_crm_deal - Create a deal
• create_crm_event - Create an event
• create_crm_lead - Create a lead
• create_crm_pipeline - Create a pipeline
• get_crm_company - Retrieve a company
• get_crm_contact - Retrieve a contact
• get_crm_deal - Retrieve a deal
• get_crm_event - Retrieve an event
• get_crm_lead - Retrieve a lead
• get_crm_pipeline - Retrieve a pipeline
• list_crm_companies - List all companies
• list_crm_contacts - List all contacts
• list_crm_deals - List all deals
• list_crm_events - List all events
• list_crm_leads - List all leads
• list_crm_pipelines - List all pipelines
• patch_crm_company - Update a company
• patch_crm_contact - Update a contact
• patch_crm_deal - Update a deal
• patch_crm_event - Update an event
• patch_crm_lead - Update a lead
• patch_crm_pipeline - Update a pipeline
• remove_crm_company - Remove a company
• remove_crm_contact - Remove a contact
• remove_crm_deal - Remove a deal
• remove_crm_event - Remove an event
• remove_crm_lead - Remove a lead
• remove_crm_pipeline - Remove a pipeline
• update_crm_company - Update a company
• update_crm_contact - Update a contact
• update_crm_deal - Update a deal
• update_crm_event - Update an event
• update_crm_lead - Update a lead
• update_crm_pipeline - Update a pipeline

• create_crm_deal - Create a deal
• get_crm_deal - Retrieve a deal
• list_crm_deals - List all deals
• patch_crm_deal - Update a deal
• remove_crm_deal - Remove a deal
• update_crm_deal - Update a deal

• create_crm_event - Create an event
• get_crm_event - Retrieve an event
• list_crm_events - List all events
• patch_crm_event - Update an event
• remove_crm_event - Remove an event
• update_crm_event - Update an event

• create_crm_lead - Create a lead
• get_crm_lead - Retrieve a lead
• list_crm_leads - List all leads
• patch_crm_lead - Update a lead
• remove_crm_lead - Remove a lead
• update_crm_lead - Update a lead

• create_crm_pipeline - Create a pipeline
• get_crm_pipeline - Retrieve a pipeline
• list_crm_pipelines - List all pipelines
• patch_crm_pipeline - Update a pipeline
• remove_crm_pipeline - Remove a pipeline
• update_crm_pipeline - Update a pipeline

• list_enrich_companies - Retrieve enrichment information for a company
• list_enrich_people - Retrieve enrichment information for a person

• list_enrich_people - Retrieve enrichment information for a person

• create_genai_prompt - Create a prompt
• list_genai_models - List all models

• list_genai_models - List all models

• create_genai_prompt - Create a prompt

• create_hris_company - Create a company
• create_hris_employee - Create an employee
• create_hris_group - Create a group
• create_hris_location - Create a location
• get_hris_company - Retrieve a company
• get_hris_employee - Retrieve an employee
• get_hris_group - Retrieve a group
• get_hris_location - Retrieve a location
• get_hris_payslip - Retrieve a payslip
• get_hris_timeoff - Retrieve a timeoff
• list_hris_companies - List all companies
• list_hris_employees - List all employees
• list_hris_groups - List all groups
• list_hris_locations - List all locations
• list_hris_payslips - List all payslips
• list_hris_timeoffs - List all timeoffs
• patch_hris_company - Update a company
• patch_hris_employee - Update an employee
• patch_hris_group - Update a group
• patch_hris_location - Update a location
• remove_hris_company - Remove a company
• remove_hris_employee - Remove an employee
• remove_hris_group - Remove a group
• remove_hris_location - Remove a location
• update_hris_company - Update a company
• update_hris_employee - Update an employee
• update_hris_group - Update a group
• update_hris_location - Update a location

• create_hris_employee - Create an employee
• get_hris_employee - Retrieve an employee
• list_hris_employees - List all employees
• patch_hris_employee - Update an employee
• remove_hris_employee - Remove an employee
• update_hris_employee - Update an employee

• create_hris_group - Create a group
• get_hris_group - Retrieve a group
• list_hris_groups - List all groups
• patch_hris_group - Update a group
• remove_hris_group - Remove a group
• update_hris_group - Update a group

• get_hris_payslip - Retrieve a payslip
• list_hris_payslips - List all payslips

• get_hris_timeoff - Retrieve a timeoff
• list_hris_timeoffs - List all timeoffs

• create_kms_page - Create a page
• create_kms_space - Create a space
• get_kms_page - Retrieve a page
• get_kms_space - Retrieve a space
• list_kms_pages - List all pages
• list_kms_spaces - List all spaces
• patch_kms_page - Update a page
• patch_kms_space - Update a space
• remove_kms_page - Remove a page
• remove_kms_space - Remove a space
• update_kms_page - Update a page
• update_kms_space - Update a space

• create_kms_page - Create a page
• get_kms_page - Retrieve a page
• list_kms_pages - List all pages
• patch_kms_page - Update a page
• remove_kms_page - Remove a page
• update_kms_page - Update a page

• create_kms_space - Create a space
• get_kms_space - Retrieve a space
• list_kms_spaces - List all spaces
• patch_kms_space - Update a space
• remove_kms_space - Remove a space
• update_kms_space - Update a space

• create_martech_list - Create a list
• create_martech_member - Create a member
• get_martech_list - Retrieve a list
• get_martech_member - Retrieve a member
• list_martech_lists - List all lists
• list_martech_members - List all members
• patch_martech_list - Update a list
• patch_martech_member - Update a member
• remove_martech_list - Remove a list
• remove_martech_member - Remove a member
• update_martech_list - Update a list
• update_martech_member - Update a member

• create_martech_list - Create a list
• get_martech_list - Retrieve a list
• list_martech_lists - List all lists
• patch_martech_list - Update a list
• remove_martech_list - Remove a list
• update_martech_list - Update a list

• create_martech_member - Create a member
• get_martech_member - Retrieve a member
• list_martech_members - List all members
• patch_martech_member - Update a member
• remove_martech_member - Remove a member
• update_martech_member - Update a member

• create_messaging_message - Create a message
• get_messaging_channel - Retrieve a channel
• get_messaging_message - Retrieve a message
• list_messaging_channels - List all channels
• list_messaging_messages - List all messages
• patch_messaging_message - Update a message
• remove_messaging_message - Remove a message
• update_messaging_message - Update a message

• get_messaging_channel - Retrieve a channel
• list_messaging_channels - List all channels

• create_messaging_message - Create a message
• get_messaging_message - Retrieve a message
• list_messaging_messages - List all messages
• patch_messaging_message - Update a message
• remove_messaging_message - Remove a message
• update_messaging_message - Update a message

• create_passthrough - Passthrough POST
• list_passthroughs - Passthrough GET
• patch_passthrough - Passthrough PUT
• remove_passthrough - Passthrough DELETE
• update_passthrough - Passthrough PUT

• create_payment_link - Create a link
• create_payment_payment - Create a payment
• get_payment_link - Retrieve a link
• get_payment_payment - Retrieve a payment
• get_payment_payout - Retrieve a payout
• get_payment_refund - Retrieve a refund
• list_payment_links - List all links
• list_payment_payments - List all payments
• list_payment_payouts - List all payouts
• list_payment_refunds - List all refunds
• patch_payment_link - Update a link
• patch_payment_payment - Update a payment
• remove_payment_link - Remove a link
• remove_payment_payment - Remove a payment
• update_payment_link - Update a link
• update_payment_payment - Update a payment

• create_payment_link - Create a link
• get_payment_link - Retrieve a link
• list_payment_links - List all links
• patch_payment_link - Update a link
• remove_payment_link - Remove a link
• update_payment_link - Update a link

• get_payment_payout - Retrieve a payout
• list_payment_payouts - List all payouts

• get_payment_refund - Retrieve a refund
• list_payment_refunds - List all refunds

• create_storage_file - Create a file
• get_storage_file - Retrieve a file
• list_storage_files - List all files
• patch_storage_file - Update a file
• remove_storage_file - Remove a file
• update_storage_file - Update a file

• create_storage_file - Create a file
• get_storage_file - Retrieve a file
• list_storage_files - List all files
• patch_storage_file - Update a file
• remove_storage_file - Remove a file
• update_storage_file - Update a file

• create_task_project - Create a project
• create_task_task - Create a task
• get_task_project - Retrieve a project
• get_task_task - Retrieve a task
• list_task_projects - List all projects
• list_task_tasks - List all tasks
• patch_task_project - Update a project
• patch_task_task - Update a task
• remove_task_project - Remove a project
• remove_task_task - Remove a task
• update_task_project - Update a project
• update_task_task - Update a task

• create_task_project - Create a project
• get_task_project - Retrieve a project
• list_task_projects - List all projects
• patch_task_project - Update a project
• remove_task_project - Remove a project
• update_task_project - Update a project

• create_ticketing_customer - Create a customer
• create_ticketing_note - Create a note
• create_ticketing_ticket - Create a ticket
• get_ticketing_customer - Retrieve a customer
• get_ticketing_note - Retrieve a note
• get_ticketing_ticket - Retrieve a ticket
• list_ticketing_customers - List all customers
• list_ticketing_notes - List all notes
• list_ticketing_tickets - List all tickets
• patch_ticketing_customer - Update a customer
• patch_ticketing_note - Update a note
• patch_ticketing_ticket - Update a ticket
• remove_ticketing_customer - Remove a customer
• remove_ticketing_note - Remove a note
• remove_ticketing_ticket - Remove a ticket
• update_ticketing_customer - Update a customer
• update_ticketing_note - Update a note
• update_ticketing_ticket - Update a ticket

• create_ticketing_customer - Create a customer
• get_ticketing_customer - Retrieve a customer
• list_ticketing_customers - List all customers
• patch_ticketing_customer - Update a customer
• remove_ticketing_customer - Remove a customer
• update_ticketing_customer - Update a customer

• create_ticketing_note - Create a note
• get_ticketing_note - Retrieve a note
• list_ticketing_notes - List all notes
• patch_ticketing_note - Update a note
• remove_ticketing_note - Remove a note
• update_ticketing_note - Update a note

• create_ticketing_ticket - Create a ticket
• get_ticketing_ticket - Retrieve a ticket
• list_ticketing_tickets - List all tickets
• patch_ticketing_ticket - Update a ticket
• remove_ticketing_ticket - Remove a ticket
• update_ticketing_ticket - Update a ticket

• create_uc_contact - Create a contact
• get_uc_contact - Retrieve a contact
• list_uc_calls - List all calls
• list_uc_contacts - List all contacts
• patch_uc_contact - Update a contact
• remove_uc_contact - Remove a contact
• update_uc_contact - Update a contact

• list_uc_calls - List all calls

• create_unified_connection - Create connection
• create_unified_webhook - Create webhook subscription
• get_unified_apicall - Retrieve specific API Call by its ID
• get_unified_connection - Retrieve connection
• get_unified_integration_auth - Create connection indirectly
• get_unified_webhook - Retrieve webhook by its ID
• list_unified_apicalls - Returns API Calls
• list_unified_connections - List all connections
• list_unified_integration_workspaces - Returns all activated integrations in a workspace
• list_unified_integrations - Returns all integrations
• list_unified_issues - List support issues
• list_unified_webhooks - Returns all registered webhooks
• patch_unified_connection - Update connection
• patch_unified_webhook - Update webhook subscription
• patch_unified_webhook_trigger - Trigger webhook
• remove_unified_connection - Remove connection
• remove_unified_webhook - Remove webhook subscription
• update_unified_connection - Update connection
• update_unified_webhook - Update webhook subscription
• update_unified_webhook_trigger - Trigger webhook

• get_unified_apicall - Retrieve specific API Call by its ID
• list_unified_apicalls - Returns API Calls

• create_unified_connection - Create connection
• get_unified_connection - Retrieve connection
• list_unified_connections - List all connections
• patch_unified_connection - Update connection
• remove_unified_connection - Remove connection
• update_unified_connection - Update connection

• get_unified_integration_auth - Create connection indirectly
• list_unified_integration_workspaces - Returns all activated integrations in a workspace
• list_unified_integrations - Returns all integrations

• get_unified_integration_auth - Create connection indirectly
• get_unified_integration_login - Sign in a user

• get_unified_integration_login - Sign in a user

• list_unified_issues - List support issues

• create_unified_webhook - Create webhook subscription
• get_unified_webhook - Retrieve webhook by its ID
• list_unified_webhooks - Returns all registered webhooks
• patch_unified_webhook - Update webhook subscription
• patch_unified_webhook_trigger - Trigger webhook
• remove_unified_webhook - Remove webhook subscription
• update_unified_webhook - Update webhook subscription
• update_unified_webhook_trigger - Trigger webhook

You can override the default server globally by passing a server index to the server_idx: int optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

The default server can also be overridden globally by passing a URL to the server_url: str optional parameter when initializing the SDK client instance. For example:

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

While we value open-source contributions to this SDK, this library is generated programmatically. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release !