11 months ago

1 month ago

Bluetrait MSP

264

API Examples

API Access is available on Standard & Professional accounts.

The API uses JSON to communicate with. We recommend Postman for testing the API yourself.

Create your API key in Settings -> API -> Add -> Access Level -> Admin

URL: https://yoursubdomain.bluetrait.io/api/

Body/Post:

{"api_key" : "your_api_key", "api_action" : "your_api_action_such_as_get_tickets", "api_version" : 1}

API Actions Include:

  • add_user
  • add_ticket
  • add_ticket_guest
  • get_ticket_priorities
  • get_ticket_departments
  • get_tickets
  • add_project
  • billing_get_invoice_lines
  • get_article
  • msp_get_agents
  • msp_get_agent
  • msp_edit_agent
  • msp_add_agent_task
  • add_company
  • get_companies

Bulk Get MSP Agents

{"api_key" : "your_api_key", "api_action" : "msp_get_agents","api_version" : 1}

For warranty purposes the fields of interest are:

  • purchase_date
  • warranty_expires
  • hw_serial_number
  • hw_manufacturer
  • hw_model

Edit MSP Agent

The edit agent allows you to write back the purchase_date & warranty_expires values. Please ensure these are in YYYY-MM-DD format. You can not bulk update agents you must call the API request for each agent you wish to update.

{"api_key" : "your_api_key","api_action" : "msp_edit_agent","api_version" : 1,"id" : ***the agent id***,"columns" : {"purchase_date" : "2020-01-03","warranty_expires" : "2023-01-03"}}

Create CRM Projects

{ "api_key" : "your_api_key", "api_action" : "add_project", "api_version" : 1, "name" : "Test Project", "company_id" : 1, "description" : "This is a test<br /><br />Project!", "date_added" : "2020-01-01 10:00:00", "date_due" : "2021-02-02 11:00:00", "status_id" : 1, "project_manager_id" : 1, "project_lead_id" : 1, "category_id" : 1, "internal" : 0 }

Create Company

{ "api_key" : "your_api_key", "api_action" : "add_company", "api_version" : 1, "name" : "Company Name", "primary_location_id" : 1, "default_billing_user_id" : 1, "default_billing_sales_tax_id" : 1 }

Get Companies

{ "api_key" : "your_api_key", "api_action" : "get_companies", "api_version" : 1 }

Please contact us if you need additional API calls or assistance with integration