menu
How to use smartQ

API

About this Guide

smartQ API developer's guide describes how to use smartQ API to access and manage you smartQ account data. This guide is intended for developers who want to programmatically access their smartQ account data through their own applications.

smartQ API represents a REST set of resources which can be accessed/managed using GET/POST/PUT/DELETE http methods. As a response to an API request, the server returns a JSON encoded array.

For example:

									 	
{"error":{"type":null,"code":405,"message":"method \"GET\" not found for resource \"\""},"data":null}
									 	
									 

"error" field - contains error details or is null if no error occurred.
"data" field - contains method call response or is null if an error occurred.

The root resource is located at https://YOUR-DOMAIN-NAME.smartqweb.com/api/v1. Not every resource supports every method. If a resource does not support a method - exception is thrown.

Signing Up for using smartQ API

In order to start using smartQ API, you need:

  • resource host: - your account host name (ex: demo.smartQweb.com)
  • login: - a valid user email
  • password: - a valid password for the provided login.
  • API access key - a client identifier, that can be obtained through "Options" > "API" on the top of your smartQ web interface (accessible to Administrators only).
  • Note: In case an API key is being regenerated - access to API is disabled for all software that uses the old API access key.
  • Make sure you are using the current API key before performing any API requests.

Attention! Be careful with the API - you can lose your data.

Authentication and access

Every API resource requires user authorization. The authorization info should be provided using basic HTTP Authorization header. Besides authorization info, in order to access API resources, the client should provide an API access key. It should be sent using X-Auth-Client-Id HTTP header or X_AUTH_CLIENT_ID request parameter. If invalid API access key is provided - an error is returned:

										
{"error":{"type":null,"code":401,"message":"Authorization failed, invalid client id"},"data":null}
										
									

Available resources and methods

Authorization token
  • POST /api/v1/oauth2/ - returns authorization and refresh token
    To receive token you must sent authorization data (login:password) and unique API access key as an array in request headers:
    array('X-Auth-Client-Id: -your API access key-')
    If your authorization token expired, you need to refresh your token. To receive a new token without login/password, you need to send a new request:
    HOST - /api/v1/oauth2/
    Method - POST
    Header parameters - array('X-Auth-Client-Id: -your API access key-', 'X-Authorization:OAUTH2 -your refresh_token-')
Example
                                                                                        
$curl = curl_init();
curl_setopt ($curl, CURLOPT_URL, "domain.smartqweb.com/api/v1/oauth2/");
curl_setopt ($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt ($curl, CURLOPT_POST, true);
curl_setopt ($curl, CURLOPT_USERPWD, "email@domain.com:11111");
curl_setopt ($curl, CURLOPT_HTTPHEADER, array(
   'X-Auth-Client-Id: 69a4d22883c57c436c4431c3982eecb2'));
$result = curl_exec($curl);
                                                                                        
                                                                                
Users
  • GET /api/v1/users/me - returns authorized user's details
  • PUT /api/v1/users/me - updates authorized user's details
  • GET /api/v1/users - returns the list of users
  • count (int) = count of users (default = 1000)
    offset (int) = get the list of users starting from 'offset' user (default=0)
  • POST /api/v1/users - adds a new user
    To POST/PUT user – send properties as an array named "user":
    user[name] (string) = user name (required)
    user[email] (string) = user email (required, unique)
    user[password] (string) = user password (required)
    user[is_account_administrator] (bool) = true if user is an account administrator
    user[can_manage_projects] (bool) = true if user can manage (add) projects
    user[can_view_profiles] (bool) = true if user can view other users' profiles
    user[can_manage_profiles] (bool) = true if user can manage other users' profiles
    user[company] (string) = company name
    user[title] (string) = job title
    user[address] (string) = address
    user[work_phone] (string) = work phone
    user[cell_phone] (string) = cell phone
    user[comments] (string) = comments
  • GET /api/v1/users/<user id> - returns user details
  • PUT /api/v1/users/<user id> - updates user details
  • DELETE /api/v1/users/<user id> - deletes user
Example: get users list
                                                                                        
$curl = curl_init();
curl_setopt ($curl, CURLOPT_URL, "http://domain.smartqweb.com/api/v1/users");
curl_setopt ($curl, CURLOPT_RETURNTRANSFER, true);

if ($token != null) {
   curl_setopt ($curl, CURLOPT_HTTPHEADER, array('X-Auth-Client-Id:033941ca17ff5ea22d3f18b22e73a86c', 'X-Authorization:OAUTH2 '.$token));
} else {
    curl_setopt ($curl, CURLOPT_USERPWD, "email@domain.com:1111");
    curl_setopt($curl, CURLOPT_HTTPHEADER, array('X-Auth-Client-Id: 69a4d22883c57c436c4431c3982eecb2'));
}

$result = curl_exec($curl);
                                                                                        
                                                                                
Example: add new user
                                                                                        
$curl = curl_init();
curl_setopt ($curl, CURLOPT_URL, "http://domain.smartqweb.com/api/v1/users");
curl_setopt ($curl, CURLOPT_RETURNTRANSFER, true);

curl_setopt ($curl, CURLOPT_POST, true);

if ($token != null) {
    curl_setopt ($curl, CURLOPT_HTTPHEADER, array('X-Auth-Client-Id:033941ca17ff5ea22d3f18b22e73a86c', 'X-Authorization:OAUTH2 '.$token));
} else {
    curl_setopt ($curl, CURLOPT_USERPWD, "email@domain.com:1111");
    curl_setopt($curl, CURLOPT_HTTPHEADER, array('X-Auth-Client-Id: 69a4d22883c57c436c4431c3982eecb2'));
}

$post = array(
   'user' => array(
       'name' => 'John Smith',
       'email' => 'johnsmith@gmail.com',
       'password' => 'zaq123',
       'is_account_administrator' => true,
       'title' => 'Director of E Commerce Jobs'
   )
);

curl_setopt ($curl, CURLOPT_POSTFIELDS, http_build_query($post));
$result = curl_exec($curl);
                                                                                        
                                                                                
Answer:
                                                                                        
{"error":null,"data":{"id":"510","email":"johnsmith@gmail.com","is_account_administrator":1,"can_manage_projects":1,"can_view_profiles":1,"can_manage_profiles":1,"name":"John Smith","company":"","title":"Director of E Commerce Jobs","address":"","work_phone":"","home_phone":"","cell_phone":"","comments":"","avatar_url":"https:\/\/domain.smartqweb.com\/img\/big_avatar.gif"}}
                                                                                        
                                                                                
Projects
  • GET /api/v1/projects - returns the list of projects (accessible by user)
    To GET project(s) you can pass these parameters (optional):
    count (int) = desired quantity of projects (default = 20)
    offset (int) = get the list of projects starting from 'offset' project (default=0)
    activeFilter (boolean) = 1 - all projects, 0 - only active projects (default = 0)
    nameFilter (int) = projects that contain 'nameFilter' in their name
  • POST /api/v1/projects - adds a new project
    To POST/PUT project - new project properties should be sent as an array named "project":
    project[name] (string) = Project name text (required)
    project[description] (string) = project description text (optional)
  • GET /api/v1/projects/<project id> - returns project details
  • PUT /api/v1/projects/<project id> - updates project details
  • DELETE /api/v1/projects/<project id> - deletes project
Example: get 10 projects, starting from the 5th, including closed ones
                                                                                        
$curl = curl_init();
curl_setopt ($curl, CURLOPT_URL, "http://domain.smartqweb.com/api/v1/projects?count=10&offset=5&activeFilter=1");
curl_setopt ($curl, CURLOPT_RETURNTRANSFER, true);

if ($token != null) {
   curl_setopt ($curl, CURLOPT_HTTPHEADER, array('X-Auth-Client-Id:033941ca17ff5ea22d3f18b22e73a86c', 'X-Authorization:OAUTH2 '.$token));
} else {
    curl_setopt ($curl, CURLOPT_USERPWD, "email@domain.com:1111");
    curl_setopt($curl, CURLOPT_HTTPHEADER, array('X-Auth-Client-Id: 69a4d22883c57c436c4431c3982eecb2'));
}

$result = curl_exec($curl);
                                                                                        
                                                                                
Example: add new project
                                                                                        
$curl = curl_init();
curl_setopt ($curl, CURLOPT_URL, "http://domain.smartqweb.com/api/v1/projects");
curl_setopt ($curl, CURLOPT_RETURNTRANSFER, true);

curl_setopt ($curl, CURLOPT_POST, true);

if ($token != null) {
   curl_setopt ($curl, CURLOPT_HTTPHEADER, array('X-Auth-Client-Id:033941ca17ff5ea22d3f18b22e73a86c', 'X-Authorization:OAUTH2 '.$token));
} else {
    curl_setopt ($curl, CURLOPT_USERPWD, "email@domain.com:1111");
    curl_setopt($curl, CURLOPT_HTTPHEADER, array('X-Auth-Client-Id: 69a4d22883c57c436c4431c3982eecb2'));
}

$post = array(
   'project' => array(
       'name' => 'New project',
       'description' => 'Project Description'
   )
);

curl_setopt ($curl, CURLOPT_POSTFIELDS, http_build_query($post));
$result = curl_exec($curl);
                                                                                        
                                                                                
Answer:
                                                                                        
{"error":null,"data":{"id":"4861","name":"New project","description":"Project created Description","owner_id":"486","active":true}}
                                                                                        
                                                                                
Remove project
               		
$curl = curl_init();
curl_setopt ($curl, CURLOPT_URL, "http://domain.smartqweb.com/api/v1/projects/99999");
curl_setopt ($curl, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_setopt ($curl, CURLOPT_RETURNTRANSFER, true);

if ($token != null) {
    curl_setopt ($curl, CURLOPT_HTTPHEADER, array('X-Auth-Client-Id:033941ca17ff5ea22d3f18b22e73a86c', 'X-Authorization:OAUTH2 '.$token));
} else {
    curl_setopt ($curl, CURLOPT_USERPWD, "email@domain.com:1111");
    curl_setopt($curl, CURLOPT_HTTPHEADER, array('X-Auth-Client-Id: 69a4d22883c57c436c4431c3982eecb2'));
}

$result = curl_exec($curl);
               		
               	
Project Roles
  • GET /api/v1/projects/<project id>/roles - returns the list of project roles
  • POST /api/v1/projects/<project id>/roles – adds a new project role
    To POST/PUT role - send properties as an array named "role":
    role[name] (string) = role name (required)
    role[access_level] (int) = access level integer [0-5] (required)
    role[max_step] (int) = role max step id user can move tickets to (optional)
    role[can_edit_project] (bool) = true if users from this role can edit project settings
    role[can_manage_people_notes] (bool) = true if users from this role can edit other people notes
    role[can_see_private_notes] (bool) = true if users from this role can see private notes
  • GET /api/v1/projects/<project id>/roles/<role id> - returns project role details
  • GET /api/v1/projects/<project id>/roles/default - returns default role details
  • PUT /api/v1/projects/<project id>/roles/<role id> - updates project role details
  • PUT /api/v1/project/<project id>/roles/default - updates default project role details
  • DELETE /api/v1/projects/<project id>roles/<role id> - deletes project role
Project Steps (Stages)
  • GET /api/v1/projects/<project id>/steps - returns the list of project steps
  • POST /api/v1/projects/<project id>/steps - adds a new project step
    To POST/PUT step - send properties as an array named "step":
    step[name] (string) = step name (required)
    step[description] (string) = step description (optional)
    step[limit] (int) = step tickets limit (optional)
    step[pos] (int) = step position (optional)
  • GET /api/v1/projects/<project id>/steps/<step id> - returns project step details
  • PUT /api/v1/projects/<project id>/steps/<step id> - updates project step details
  • DELETE /api/v1/projects/<project id>/steps/<step id> - deletes project step
Project Custom Fields
  • GET /api/v1/projects/<project id>/custom_fields - returns the list of project custom fields with available values (for choice type fields only)
  • GET /api/v1/projects/<project id>/custom_fields/<field name> - returns field properties including the available values (where applicable)
  • POST /api/v1/projects/<project id>/custom_fields - adds a new custom filed to the project
    To POST/PUT a custom field - send properties as an array named "field":
    field[type] (string) = field type (required); available values: float, string, text, choice
    field[label] (string) = field label (required)
    field[hint] (string) = field description
    field[required] (bool) = field is mandatory or optional
    field[pos_type] (string) = defines the way the new custom field is represented in smartQ web interface; available values: single, double
    field[options][choiceType] (string) = type of choice field; available values: checkbox, radio, select
    field[options][min] (float) = minimal allowed value (for float type fields only)
    field[options][max] (float) = maximal allowed value (for float type fields only)
    field[options][fieldLayout] (string) = list of choice values for this field (for radio, checkbox and select types only)
  • PUT /api/v1/projects/<project id>/custom_fields/<field name> - updates custom filed details
  • DELETE /api/v1/projects/<project id>/custom_fields/<field name> - deletes custom field
Example: get project custom fields list
               		
$curl = curl_init();
curl_setopt ($curl, CURLOPT_URL, "http://domain.smartqweb.com/api/v1/projects/99999/custom_fields");
curl_setopt ($curl, CURLOPT_RETURNTRANSFER, true);

if ($token != null) {
   curl_setopt ($curl, CURLOPT_HTTPHEADER, array('X-Auth-Client-Id:033941ca17ff5ea22d3f18b22e73a86c', 'X-Authorization:OAUTH2 '.$token));
} else {
    curl_setopt ($curl, CURLOPT_USERPWD, "email@domain.com:1111");
    curl_setopt($curl, CURLOPT_HTTPHEADER, array('X-Auth-Client-Id: 69a4d22883c57c436c4431c3982eecb2'));
}

$fields = curl_exec($curl);
               		
               	
Example: adds a new custom field to a project
               		
$curl = curl_init();
curl_setopt ($curl, CURLOPT_URL, "http://domain.smartqweb.com/api/v1/projects/99999/custom_fields");
curl_setopt ($curl, CURLOPT_RETURNTRANSFER, true);

curl_setopt ($curl, CURLOPT_POST, true);

if ($token != null) {
   curl_setopt ($curl, CURLOPT_HTTPHEADER, array('X-Auth-Client-Id:033941ca17ff5ea22d3f18b22e73a86c', 'X-Authorization:OAUTH2 '.$token));
} else {
    curl_setopt ($curl, CURLOPT_USERPWD, "email@domain.com:1111");
    curl_setopt($curl, CURLOPT_HTTPHEADER, array('X-Auth-Client-Id: 69a4d22883c57c436c4431c3982eecb2'));
}

$post = array(
   'field' => array(
       'type' => 'float',
       'label' => 'New field',
       'hint' => 'New field from API',
       'required' => true,
       'options' => array(
            'min' => 1,
            'max' => 99
       )
   )
);

curl_setopt ($curl, CURLOPT_POSTFIELDS, http_build_query($post));
$result = curl_exec($curl);
               		
               	
Project Custom Field Values (for custom fields of type "choice")
  • GET /api/v1/projects/<project id>/custom_fields/<field name>/values - returns the list of custom field values
  • GET /api/v1/projects/<project id>/custom_fields/<field name>/values/<value id> - returns field value properties
  • POST /api/v1/projects/<project id>/custom_fields/<field name>/values - adds a new value to the custom field
    To POST/PUT a field value - send properties as an array named "value":
    value[title] (string) = value title (required);
    value[is_default] (bool) = value is default for this custom field
    value[pos] (bool) = value position in the list
  • PUT /api/v1/projects/<project id>/custom_fields/<field name>/values/<value id> - updates custom filed value details
  • DELETE /api/v1/projects/<project id>/custom_fields/<field name>/values/<value id> - deletes custom field value
Tickets
  • GET /api/v1/projects/<project id>/tickets – returns the list of tickets
    count (int) = number of tickets (default = 20)
    offset (int) = get the list of tickets starting from 'offset' ticket (default=0)
    orderCol (string) = field by which tickets are sorted (possible values: insert_time, update_time, move_time, title, pos, deadline_date) (default = insert_time)
    reverse (bool) = sorting direction, 1 - DESC, 0 - ASC (default = 1)
    custom_fields (bool) = 1 or 0 to include custom field values for each ticket (might increase the response time) (default = 0)
    assigned_to (bool) = include assigned users for each ticket (might increase the response time)(default = 0)
    archived (int) = 0 - include only active tickets, 1 - include only archived tickets, 2 - include all tickets (default = 0)
    get_info_by_note (bool) = 1 or 0 to include notes for each ticket (might increase the response time) (default = 0)
    get_cover (bool) = 1 or 0 to include cover image (if it exists) for each ticket (might increase the response time) (default = 1)
    assignedToId (int) = get the tickets which contain the assigned user with specified id
    nameFilter (string) = get the tickets that contain 'nameFilter' in the name
    requiredByFilter (string) = get the tickets for which the deadline is earlier than the specified date (format: 2017=12-31 08:30:00)
    stepIdFilter (int) = id of the step for which you want to get the tickets
    fields (string) = if you do not want to get all the ticket fields, you can list specific fields separated by commas, for example: fields=name,description,deadline_date
  • POST /api/v1/projects/<project id>/tickets – adds a new ticket
    To POST/PUT ticket - send properties as an array named "ticket":
    ticket[name] (string) = ticket name text (required)
    ticket[description] (string) = ticket description text (optional)
    ticket[step_id] (int) = ticket step_id (required)
    ticket[tags] (string) = comma separated tags (optional)
    ticket[required_by] (string) = required by date (optional)
    ticket[assigned_to] (int[]) = array of users IDs to assign ticket to (optional)
    ticket[notify_involved] (bool) = 1 or 0 to send notification to ticket team
  • GET /api/v1/projects/<project id>/tickets/<ticket id> - returns ticket details
  • PUT /api/v1/projects/<project id>/tickets/<ticket id> - updates ticket details
  • DELETE /api/v1/projects/<project id>/tickets/<ticket id> - deletes ticket
Example: get 50 tickets with notes, covers and assigned users, sorted by creation date
                                                                                        
$curl = curl_init();
curl_setopt ($curl, CURLOPT_URL, "http://domain.smartqweb.com/api/v1/projects/99999/tickets?count=50&get_info_by_note=1&assigned_to=1&get_cover=1&orderCol=insert_time");
curl_setopt ($curl, CURLOPT_RETURNTRANSFER, true);

if ($token != null) {
   curl_setopt ($curl, CURLOPT_HTTPHEADER, array('X-Auth-Client-Id:033941ca17ff5ea22d3f18b22e73a86c', 'X-Authorization:OAUTH2 '.$token));
} else {
    curl_setopt ($curl, CURLOPT_USERPWD, "email@domain.com:1111");
    curl_setopt($curl, CURLOPT_HTTPHEADER, array('X-Auth-Client-Id: 69a4d22883c57c436c4431c3982eecb2'));
}

$result = curl_exec($curl);
                                                                                        
                                                                                
Example: add ticket
               		
$curl = curl_init();
curl_setopt ($curl, CURLOPT_URL, "http://domain.smartqweb.com/api/v1/projects/99999/tickets");
curl_setopt ($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt ($curl, CURLOPT_POST, true);

if ($token != null) {
   curl_setopt ($curl, CURLOPT_HTTPHEADER, array('X-Auth-Client-Id:033941ca17ff5ea22d3f18b22e73a86c', 'X-Authorization:OAUTH2 '.$token));
} else {
    curl_setopt ($curl, CURLOPT_USERPWD, "email@domain.com:1111");
    curl_setopt($curl, CURLOPT_HTTPHEADER, array('X-Auth-Client-Id: 69a4d22883c57c436c4431c3982eecb2'));
}

$post = array(
   'ticket' => array(
       'name' =>'New Ticket',
       'description' => 'New Ticket Description',
       'step_id' => 88888,
       'assigned_to' => array(1, 2, 3, 5)
   )
);
curl_setopt ($curl, CURLOPT_POSTFIELDS, http_build_query($post));
$result = curl_exec($curl);
               		
               	
Example: add ticket with custom fields
               		
$curl = curl_init();
curl_setopt ($curl, CURLOPT_URL, "http://domain.smartqweb.com/api/v1/projects/99999/tickets");
curl_setopt ($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt ($curl, CURLOPT_POST, true);

if ($token != null) {
   curl_setopt ($curl, CURLOPT_HTTPHEADER, array('X-Auth-Client-Id:033941ca17ff5ea22d3f18b22e73a86c', 'X-Authorization:OAUTH2 '.$token));
} else {
    curl_setopt ($curl, CURLOPT_USERPWD, "email@domain.com:1111");
    curl_setopt($curl, CURLOPT_HTTPHEADER, array('X-Auth-Client-Id: 69a4d22883c57c436c4431c3982eecb2'));
}

$post = array(
   'ticket' => array(
       'name' =>'New Ticket',
       'description' => 'New Ticket Description',
       'step_id' => 88888,
       'assigned_to' => array(1, 2, 3, 5),
   // here come the values for the custom fields
       'f3' => 'some important info',
       'f4' => 2017,
       'f5' => array(1234, 4321)
   )
);
curl_setopt ($curl, CURLOPT_POSTFIELDS, http_build_query($post));
$result = curl_exec($curl);
               		
               	
Notes
  • GET /api/v1/projects/<project id>/tickets/<ticket id>/notes – returns the list of notes
  • count (int) = number of notes (default = 20)
    offset (int) = get the list of notes starting from 'offset' note (default=0)
  • POST /api/v1/projects/<project id>/tickets/<ticket id>/notes – adds a new ticket note
    To POST/PUT note - send properties as an array named "note":
    note[text] (string) = note text, limited HTML tags are allowed (required)
    note[parent_id] (int) = id of the parent note (optional, for threaded conversations)
    note[private] (bool) = private flag (optional)
    note[notify_users] (bool) = true to notify users about new message (optional)
    note[users] (array) = array of users IDs to notify
    note[has_attachments] (bool) = if true than no notifications are sent until "is_last_file" flag is received, together with the last attached file of the note
  • GET /api/v1/projects/<project id>/tickets/<ticket id>/notes/<note id> - gets note details
  • PUT /api/v1/projects/<project id>/tickets/<ticket id>/notes/<note id> - updates note details
  • DELETE /api/v1/projects/<project id>/tickets/<ticket id>/notes/<note id> - deletes note
Example: get 10 notes for ticket with id 12345
                                                                                        
$curl = curl_init();
curl_setopt ($curl, CURLOPT_URL, "http://domain.smartqweb.com/api/v1/projects/99999/tickets/12345/notes?count=10");
curl_setopt ($curl, CURLOPT_RETURNTRANSFER, true);

if ($token != null) {
   curl_setopt ($curl, CURLOPT_HTTPHEADER, array('X-Auth-Client-Id:033941ca17ff5ea22d3f18b22e73a86c', 'X-Authorization:OAUTH2 '.$token));
} else {
    curl_setopt ($curl, CURLOPT_USERPWD, "email@domain.com:1111");
    curl_setopt($curl, CURLOPT_HTTPHEADER, array('X-Auth-Client-Id: 69a4d22883c57c436c4431c3982eecb2'));
}

$result = curl_exec($curl);
                                                                                        
                                                                                
Example: add new answer for note with id 1405846
                                                                                        
$curl = curl_init();
curl_setopt ($curl, CURLOPT_URL, "http://domain.smartqweb.com/api/v1/projects/99999/tickets/12345/notes");
curl_setopt ($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt ($curl, CURLOPT_POST, true);

if ($token != null) {
   curl_setopt ($curl, CURLOPT_HTTPHEADER, array('X-Auth-Client-Id:033941ca17ff5ea22d3f18b22e73a86c', 'X-Authorization:OAUTH2 '.$token));
} else {
    curl_setopt ($curl, CURLOPT_USERPWD, "email@domain.com:1111");
    curl_setopt($curl, CURLOPT_HTTPHEADER, array('X-Auth-Client-Id: 69a4d22883c57c436c4431c3982eecb2'));
}
$post = array(
   'note' => array(
       'text' =>'New Note',
       'top_parent_id' =>'1405846'
    )
);
curl_setopt ($curl, CURLOPT_POSTFIELDS, http_build_query($post));
$result = curl_exec($curl);

                                                                                        
                                                                                
Tasks
  • GET /api/v1/projects/<project id>/tickets/<ticket id>/tasks – returns the list of ticket tasks
  • count (int) = count of tasks (default = 20)
    offset (int) = get the list of tasks starting from 'offset' task (default=0)
  • POST /api/v1/projects/<project id>/tickets/<ticket id>/tasks – adds a new ticket task
    task (string) = task text (required)
  • PUT /api/v1/projects/<project id>/tickets/<ticket id>/tasks/<task id> - updates task details
  • POST /api/v1/projects/<project id>/tickets/<ticket id>/tasks – adds a new ticket note
    To POST/PUT task - send properties as an array named "task":
    task[text] (string) = task text (required)
    task[done] (bool) = mark/unmark task as done (default=0)
  • DELETE /api/v1/projects/<project id>/tickets/<ticket id>/tasks/<task id> - deletes task
Example: get 10 tasks for ticket with id 12345
                                                                                        
$curl = curl_init();
curl_setopt ($curl, CURLOPT_URL, "http://domain.smartqweb.com/api/v1/projects/99999/tickets/12345/tasks?count=10");
curl_setopt ($curl, CURLOPT_RETURNTRANSFER, true);

if ($token != null) {
   curl_setopt ($curl, CURLOPT_HTTPHEADER, array('X-Auth-Client-Id:033941ca17ff5ea22d3f18b22e73a86c', 'X-Authorization:OAUTH2 '.$token));
} else {
    curl_setopt ($curl, CURLOPT_USERPWD, "email@domain.com:1111");
    curl_setopt($curl, CURLOPT_HTTPHEADER, array('X-Auth-Client-Id: 69a4d22883c57c436c4431c3982eecb2'));
}

$result = curl_exec($curl);
                                                                                        
                                                                                
Example: add new task for note with id 1405846
                                                                                        
$curl = curl_init();
curl_setopt ($curl, CURLOPT_URL, "http://domain.smartqweb.com/api/v1/projects/99999/tickets/12345/tasks");
curl_setopt ($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt ($curl, CURLOPT_POST, true);

if ($token != null) {
   curl_setopt ($curl, CURLOPT_HTTPHEADER, array('X-Auth-Client-Id:033941ca17ff5ea22d3f18b22e73a86c', 'X-Authorization:OAUTH2 '.$token));
} else {
    curl_setopt ($curl, CURLOPT_USERPWD, "email@domain.com:1111");
    curl_setopt($curl, CURLOPT_HTTPHEADER, array('X-Auth-Client-Id: 69a4d22883c57c436c4431c3982eecb2'));
}
$post = array(
    'task' =>'New Task'
);
curl_setopt ($curl, CURLOPT_POSTFIELDS, http_build_query($post));
$result = curl_exec($curl);

                                                                                        
                                                                                
Files
  • GET /api/v1/projects/<project id>/tickets/<ticket id>/notes/<note id>/files - returns list of files attached to the note
  • POST /api/v1/projects/<project id>/tickets/<ticket id>/notes/<note id>/filesv2 - uploads a new file
    To POST file - send file as a standard POST file named "file" (please check this example). Please note that you have to make a separate request for each file you would like to upload.
  • GET /api/v1/projects/<project id>/tickets/<ticket id>/notes/<note id>/files/<file id> - returns file details
  • GET /api/v1/projects/<project id>/tickets/<ticket id>/notes/<note id>/files/<file id>/download - returns file body
  • DELETE /api/v1/projects/<project id>/tickets/<ticket id>/notes/<note id>/files/<file id> - deletes a file
Example: upload file
               		
$curl = curl_init();
curl_setopt ($curl, CURLOPT_URL, "http://domain.smartqweb.com/api/v1/projects/99999/tickets/77777/notes/55555/filesv2");
curl_setopt ($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt ($curl, CURLOPT_POST, true);
curl_setopt ($curl, CURLOPT_HTTPAUTH, CURLAUTH_BASIC ) ;
curl_setopt ($curl, CURLOPT_USERPWD, "email@domain.com:11111");
curl_setopt ($curl, CURLOPT_HTTPHEADER, array(
   'X-Auth-Client-Id: 69a4d22883c57c436c4431c3982eecb2'));

$file_name = 'image.jpg';
$file_name_with_full_path = realpath($file_name);

//Notice the @ prefixing local file path - it does the trick.
$post = array(
    "file"=>'@'.$file_name_with_full_path,
);
curl_setopt ($curl, CURLOPT_POSTFIELDS, http_build_query($post));
$result = curl_exec($curl);