Aritic Desk API Doc

Welcome to the Aritic Desk API documentation! To simplify a developer's work, we at Aritic Desk have built developer-friendly APIs which are supported by the major programming languages to interact with your PinPoint instance.

We have language bindings for PHP, Java, Shell, Ruby and Python! You can view code examples on the right side of this page and use the top right tabs to switch between different programming languages.

Our APIs work over the HTTP protocol with JSON and build in an RPC-like manner, and you can do anything with the API's using their particular action provided. All the HTTP requests must be made over HTTPS URL given in the action defined in this documentation. All responses you receive from the API will return in JSON.

Requests should be made using the POST method with any parameters encoded as JSON in the body of the request.

Authentication

Basic Authentication Key

$echo "username password" | base64


Output :  qwertEBkYXRhYWVnaXMuY29tOmFydWxqwert

<?php
        echo base64_encode("username:password");
?>

byte[] encodedBytes = Base64.encodeBase64("username:password".getBytes());
System.out.println("encodedBytes " + new String(encodedBytes));

To authenticate with Aritic Desk you must have a valid Aritic Desk authorization key.To generate authorization key you need to have an Aritic Desk account, in case you don't have an account, please use the following link for Registration .

Once you have an account with Aritic Desk, you can use various code snippets on the right panel to create your authorization key.

Aritic Desk expects for the authorization key to be included in all API requests to the server in a header that looks like the following:

"'authorization: Basic qwertEBkYXRhYWVnaXMuY29tOmFydWxqwert'"

You must replace qwertEBkYXRhYWVnaXMuY29tOmFydWxqwert with your personal authorization key.

You must replace your_domain_name in https://your_domain_name.aritic.com/ma/api/.. with your domain name.

Ticket

List

curl --request GET \
  --url http://your_domain_name/api/v1/tickets \
  --header 'Authorization: Basic g6r3b8692un9274729hb2974bci3hh94nifuh020jffje' \
  --header 'cache-control: no-cache'

{
        "id": 1,
        "group_id": 1,
        "priority_id": 2,
        "state_id": 1,
        "organization_id": 1,
        "number": "45001",
        "title": "Welcome to Dataaegis!",
        "owner_id": 1,
        "customer_id": 2,
        "note": null,
        "first_response_at": null,
        "first_response_escalation_at": null,
        "first_response_in_min": null,
        "first_response_diff_in_min": null,
        "close_at": null,
        "close_escalation_at": null,
        "close_in_min": null,
        "close_diff_in_min": null,
        "update_escalation_at": null,
        "update_in_min": null,
        "update_diff_in_min": null,
        "last_contact_at": "2019-03-08T19:47:02.323Z",
        "last_contact_agent_at": null,
        "last_contact_customer_at": "2019-03-08T19:47:02.323Z",
        "last_owner_update_at": null,
        "create_article_type_id": 5,
        "create_article_sender_id": 2,
        "article_count": 1,
        "escalation_at": null,
        "pending_time": null,
        "type": null,
        "time_unit": null,
        "preferences": {},
        "updated_by_id": 2,
        "created_by_id": 2,
        "created_at": "2019-03-08T19:47:02.150Z",
        "updated_at": "2019-03-08T19:47:02.432Z"
    }

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("http://your_domain_name/api/v1/tickets")
  .get()
  .addHeader("Authorization", "Basic n438dWNhQGRhdGFhZWdpcy5jb206TW9uaWNhX0AxMjM0")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://your_domain_name/api/v1/tickets",
  "method": "GET",
  "headers": {
    "Authorization": "Basic u6eb5WNhQGRhdGFhZWdpcy5jb206TW9uaWNhX0AxMjM0",
    "cache-control": "no-cache",
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

<?php

$request = new HttpRequest();
$request->setUrl('http://your_domain_name/api/v1/tickets');
$request->setMethod(HTTP_METH_GET);

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'Authorization' => 'Basic urn73WNhQGRhdGFhZWdpcy5jb206TW9uaWNhX0AxMjM0'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

require 'uri'
require 'net/http'

url = URI("http://your_domain_name/api/v1/tickets")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic nud34WNhQGRhdGFhZWdpcy5jb206TW9uaWNhX0AxMjM0'
request["cache-control"] = 'no-cache'
response = http.request(request)
puts response.read_body

import requests

url = "http://your_domain_name/api/v1/tickets"

payload = ""
headers = {
    'Authorization': "Basic nh236WNhQGRhdGFhZWdpcy5jb206TW9uaWNhX0AxMjM0",
    'cache-control': "no-cache",
    }

response = requests.request("GET", url, data=payload, headers=headers)

print(response.text)

Get a list of tickets.

Required permission

ticket.agent (access to all ticket in allocated groups)
ticket.customer (access to all ticket with customer_id ** current_user.id || organization_id ** current_user.organization_id)

HTTP Request

GET /api/v1/tickets

Response

Expected Response Code: 200

Search

[
 {
   "id": 123,
   "title": "Help me!",
   "group_id": 1,
   "state_id": 1,
   "priority_id": 2,
   "customer_id": 2,
   ...
   "note": "some note",
   "updated_at": "2016-08-16T07:55:42.119Z",
   "created_at": "2016-08-16T07:55:42.119Z"
 },
 {
   "id": 124,
   "title": "Just want to ask for support",
   "state_id": 2,
   "priority_id": 2,
   "customer_id": 2,
   ...
   "note": "some note",
   "updated_at": "2016-08-16T07:55:42.119Z",
   "created_at": "2016-08-16T07:55:42.119Z"
 },
]

curl --request GET \
  --url 'http://your_domain_name/api/v1/tickets/search?query=what&limit=10' \
  --header 'Authorization: Basic hd736WNhQGRhdGFhZWdpcy5jb206TW9uaWNhX0AxMjM0' \
  --header 'cache-control: no-cache'

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("http://your_domain_name/api/v1/tickets/search?query=what&limit=10")
  .get()
  .addHeader("Authorization", "Basic yh647WNhQGRhdGFhZWdpcy5jb206TW9uaWNhX0AxMjM0")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://your_domain_name/api/v1/tickets/search?query=what&limit=10",
  "method": "GET",
  "headers": {
    "Authorization": "Basic nh764WNhQGRhdGFhZWdpcy5jb206TW9uaWNhX0AxMjM0",
    "cache-control": "no-cache",
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

<?php

$request = new HttpRequest();
$request->setUrl('http://your_domain_name/api/v1/tickets/search');
$request->setMethod(HTTP_METH_GET);

$request->setQueryData(array(
  'query' => 'what',
  'limit' => '10'
));

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'Authorization' => 'Basic jdh3WNhQGRhdGFhZWdpcy5jb206TW9uaWNhX0Ahd3M0'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

require 'uri'
require 'net/http'

url = URI("http://your_domain_name/api/v1/tickets/search?query=what&limit=10")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic nh647WNhQGRhdGFhZWdpcy5jb206TW9uaWNhuhn5MjM0'
request["cache-control"] = 'no-cache'

response = http.request(request)
puts response.read_body

import requests

url = "http://your_domain_name/api/v1/tickets/search"

querystring = {"query":"what","limit":"10"}

payload = ""
headers = {
    'Authorization': "Basic nh77sWNhQGRhdGFhZWdpcy5jb206TW9uaWNhBG45nMjM0",
    'cache-control': "no-cache",
    }

response = requests.request("GET", url, data=payload, headers=headers, params=querystring)

print(response.text)

Search tickets using any attribute.

Required permission

ticket.agent (access to all ticket in allocated groups)
ticket.customer (access to all ticket with customer_id ** current_user.id || organization_id ** current_user.organization_id)

HTTP Request

GET /api/v1/tickets/search?query=what&limit=10

Here, "query" - is any attribute of Ticket & "what" - value of that attribute

Response

Expected Response Code: 200

Show

{
    "id": 1,
    "group_id": 1,
    "priority_id": 2,
    "state_id": 1,
    "organization_id": 1,
    "number": "45001",
    "title": "Welcome to Zammad!",
    "owner_id": 1,
    "customer_id": 2,
    "note": null,
    "first_response_at": null,
    "first_response_escalation_at": null,
    "first_response_in_min": null,
    "first_response_diff_in_min": null,
    "close_at": null,
    "close_escalation_at": null,
    "close_in_min": null,
    "close_diff_in_min": null,
    "update_escalation_at": null,
    "update_in_min": null,
    "update_diff_in_min": null,
    "last_contact_at": "2019-03-08T19:47:02.323Z",
    "last_contact_agent_at": null,
    "last_contact_customer_at": "2019-03-08T19:47:02.323Z",
    "last_owner_update_at": null,
    "create_article_type_id": 5,
    "create_article_sender_id": 2,
    "article_count": 1,
    "escalation_at": null,
    "pending_time": null,
    "type": null,
    "time_unit": null,
    "preferences": {},
    "updated_by_id": 2,
    "created_by_id": 2,
    "created_at": "2019-03-08T19:47:02.150Z",
    "updated_at": "2019-03-08T19:47:02.432Z"
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("http://your_domain_name/api/v1/tickets")
  .post(null)
  .addHeader("Authorization", "Basic bhtA3WNhQGRhdGFhZWdpcy5jb206TW9nhANhX0AxMjM0")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://your_domain_name/api/v1/tickets",
  "method": "POST",
  "headers": {
    "Authorization": "Basic bt23AWNhQGRhdGFhZWdpcy5jb206TW9uDB23X0AxMjM0",
    "cache-control": "no-cache",
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

<?php

$request = new HttpRequest();
$request->setUrl('http://your_domain_name/api/v1/tickets');
$request->setMethod(HTTP_METH_POST);

$request->setHeaders(array(

  'cache-control' => 'no-cache',
  'Authorization' => 'Basic bhySEG5WWNhQGRhdGFhZWdpcy5jb206TW9uaWNhX0AxMjM0'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

import requests

url = "http://your_domain_name/api/v1/tickets"

payload = ""
headers = {
    'Authorization': "Basic bhyrh6ju3uGRhdGFhZWdpcy5jb206TW9uaWNhX0AxMjM0",
    'cache-control': "no-cache",
    }

response = requests.request("POST", url, data=payload, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

url = URI("http://your_domain_name/api/v1/tickets")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic nhuhjdsNhQGRhdGFhZWdpcy5jb206TW9uaWNhX0AxMjM0'
request["cache-control"] = 'no-cache'

response = http.request(request)
puts response.read_body

curl --request POST \
  --url http://your_domain_name/api/v1/tickets \
  --header 'Authorization: Basic nhg67WNhQGRhdGFhZWdpcy5jb206TW9uaWNhX0AxMjM0' \
  --header 'cache-control: no-cache'

Displays a ticket information using id attribute.

Required permission

ticket.agent (access to all ticket in allocated groups)
ticket.customer (access to all ticket with customer_id ** current_user.id || organization_id ** current_user.organization_id)

HTTP Request

GET /api/v1/tickets/{id}

Response

Expected Response Code: 200

Create

curl --request POST \
  --url http://your_domain_name/api/v1/tickets \
  --header 'Authorization: Basic 23gBJJWNhQGRhdGFhZWdpcy5jb206TW9uaWNhX0nhSjM0' \
  --header 'cache-control: no-cache'

{
    "id": 3,
    "group_id": 1,
    "priority_id": 2,
    "state_id": 1,
    "organization_id": null,
    "number": "45003",
    "title": "Help me!",
    "owner_id": 1,
    "customer_id": 5,
    "note": "some note",
    "first_response_at": null,
    "first_response_escalation_at": null,
    "first_response_in_min": null,
    "first_response_diff_in_min": null,
    "close_at": null,
    "close_escalation_at": null,
    "close_in_min": null,
    "close_diff_in_min": null,
    "update_escalation_at": null,
    "update_in_min": null,
    "update_diff_in_min": null,
    "last_contact_at": null,
    "last_contact_agent_at": null,
    "last_contact_customer_at": null,
    "last_owner_update_at": null,
    "create_article_type_id": 10,
    "create_article_sender_id": 1,
    "article_count": 1,
    "escalation_at": null,
    "pending_time": null,
    "type": null,
    "time_unit": null,
    "preferences": {},
    "updated_by_id": 5,
    "created_by_id": 5,
    "created_at": "2019-03-15T06:07:12.038Z",
    "updated_at": "2019-03-15T06:07:12.447Z",
    "article_ids": [
        3
    ],
    "ticket_time_accounting_ids": []
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("http://your_domain_name/api/v1/tickets")
  .post(null)
  .addHeader("Authorization", "Basic bHY23WNhQGRhdGFhZWdpcy5jb206TW9uaWNHs0AxMjM0")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://your_domain_name/api/v1/tickets",
  "method": "POST",
  "headers": {
    "Authorization": "Basic junG4WNhQGRhdGFhZWdpcy5jb206TW9uaWNJUbgxMjM0",
    "cache-control": "no-cache",
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

<?php

$request = new HttpRequest();
$request->setUrl('http://your_domain_name/api/v1/tickets');
$request->setMethod(HTTP_METH_POST);

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'Authorization' => 'Basic njHG3WNhQGRhdGFhZWdpcy5jb206TW9uaWNhX0AxMjM0'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

import requests

url = "http://your_domain_name/api/v1/tickets"

payload = ""
headers = {
    'Authorization': "Basic nhgE4WNhQGRhdGFhZWdpcy5jb206TW9uaWOSdb4AxMjM0",
    'cache-control': "no-cache",
    }

response = requests.request("POST", url, data=payload, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

url = URI("http://your_domain_name/api/v1/tickets")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic bhRT4WNhQGRhdGFhZWdpcy5jb206TW9uaNH5X0AxMjM0'
request["cache-control"] = 'no-cache'

response = http.request(request)
puts response.read_body

Creates a new Ticket.

Required permission

ticket.agent (create in all allocated groups)
ticket.customer

HTTP Request

POST /api/v1/tickets

Response

Expected Response Code: 200

Update

curl --request PUT \
  --url http://your_domain_name/api/v1/tickets/2 \
  --header 'Authorization: Basic nhJu4WNhQGRhdGFhZWdpcy5jb206TW9uaWNhX0AxMjM0' \
  --header 'Content-Type: application/json' \
  --header 'cache-control: no-cache' \
  --data '{\r\n "title": "Help me!"\r\n}'

{
    "id": 2,
    "group_id": 1,
    "priority_id": 2,
    "state_id": 2,
    "organization_id": null,
    "number": "45002",
    "title": "Help me!",
    "owner_id": 1,
    "customer_id": 7,
    "note": null,
    "first_response_at": null,
    "first_response_escalation_at": null,
    "first_response_in_min": null,
    "first_response_diff_in_min": null,
    "close_at": null,
    "close_escalation_at": null,
    "close_in_min": null,
    "close_diff_in_min": null,
    "update_escalation_at": null,
    "update_in_min": null,
    "update_diff_in_min": null,
    "last_contact_at": "2019-03-12T08:47:20.059Z",
    "last_contact_agent_at": null,
    "last_contact_customer_at": "2019-03-12T08:47:20.059Z",
    "last_owner_update_at": null,
    "create_article_type_id": 5,
    "create_article_sender_id": 2,
    "article_count": 1,
    "escalation_at": null,
    "pending_time": null,
    "type": null,
    "time_unit": null,
    "preferences": {},
    "updated_by_id": 6,
    "created_by_id": 5,
    "created_at": "2019-03-12T08:47:19.905Z",
    "updated_at": "2019-03-12T13:05:42.141Z",
    "article_ids": [
        2
    ],
    "ticket_time_accounting_ids": []
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\r\n \"title\": \"Help me!\"\r\n}");
Request request = new Request.Builder()
  .url("http://your_domain_name/api/v1/tickets/2")
  .put(body)
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Basic bhy34WNhQGRhdGFhZWdpcy5jb206TW9uaWNhX0AxMjM0")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://your_domain_name/api/v1/tickets/2",
  "method": "PUT",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Basic nhds7iNhQGRhdGFhZWdpcy5jb206TW9uaWNhX0AxMjM0",
    "cache-control": "no-cache",
  },
  "processData": false,
  "data": "{\r\n \"title\": \"Help me!\"\r\n}"
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

<?php

$request = new HttpRequest();
$request->setUrl('http://your_domain_name/api/v1/tickets/2');
$request->setMethod(HTTP_METH_PUT);

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'Authorization' => 'Basic nhy22WNhQGRhdGFhZWdpcy5jb206TW9uaWNhX0AxMjM0',
  'Content-Type' => 'application/json'
));

$request->setBody('{
 "title": "Help me!"
}');

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

import requests

url = "http://your_domain_name/api/v1/tickets/2"

payload = "{\r\n \"title\": \"Help me!\"\r\n}"
headers = {
    'Content-Type': "application/json",
    'Authorization': "Basic hdy34WNhQGRhdGFhZWdpcy5jb206TW9uaWNhX0AxMjM0",
    'cache-control': "no-cache",
    }

response = requests.request("PUT", url, data=payload, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

url = URI("http://your_domain_name/api/v1/tickets/2")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request["Authorization"] = 'Basic nhyE4WNhQGRhdGFhZWdpcy5jb206TW9uaWNhX0AxMjM0'
request["cache-control"] = 'no-cache'
request.body = "{\r\n \"title\": \"Help me!\"\r\n}"

response = http.request(request)
puts response.read_body

Update any ticket using id.

Required permission

ticket.agent (access to all ticket in allocated groups)
ticket.customer (access to all ticket with customer_id ** current_user.id || organization_id ** current_user.organization_id)

HTTP Request

PUT /api/v1/tickets/{id}

Response

Expected Response Code: 200

Delete

{}

curl --request DELETE \
  --url 'http://your_domain_name/api/v1/tickets/{id}' \
  --header 'Authorization: Basic nhy23WNhQGRhdGFhZWdpcy5jb206TW9uanhuX0AxMjM0' \
  --header 'cache-control: no-cache'

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("http://your_domain_name/api/v1/tickets/{id}")
  .delete(null)
  .addHeader("Authorization", "Basic nhu35WNhQGRhdGFhZWdpcy5jb206nhtuaWNhX0AxMjM0")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://your_domain_name/api/v1/tickets/{id}",
  "method": "DELETE",
  "headers": {
    "Authorization": "Basic nhy56WNhQGRhdGFhZWdpcy5jb206TW9uaWNhX0AxMjM0",
    "cache-control": "no-cache",

  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

<?php

$request = new HttpRequest();
$request->setUrl('http://your_domain_name/api/v1/tickets/{id}');
$request->setMethod(HTTP_METH_DELETE);

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'Authorization' => 'Basic nhy673hQGRhdGFhZWdpcy5jb206TW9juWNhX0AxMjM0'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

import requests

url = "http://your_domain_name/api/v1/tickets/{id}"

payload = ""
headers = {
    'Authorization': "Basic nhyt6WNhQGRhdGFhZWdpcy5jb206TW9uaWNhXnjxMjM0",
    'cache-control': "no-cache",
    }

response = requests.request("DELETE", url, data=payload, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

url = URI("http://your_domain_name/api/v1/tickets/{id}")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Basic hsy89WNhQGRhdGFhZWdpcy5jb206TW9uaWkiX0AxMjM0'
request["cache-control"] = 'no-cache'


response = http.request(request)
puts response.read_body

Delete a tickets using it's ID.

Required permission

admin

HTTP Request

DELETE /api/v1/tickets/{id}

Response

Expected Response code: 200

Ticket State

List

 {
        "id": 1,
        "state_type_id": 1,
        "name": "new",
        "next_state_id": null,
        "ignore_escalation": false,
        "default_create": true,
        "default_follow_up": false,
        "note": null,
        "active": true,
        "updated_by_id": 1,
        "created_by_id": 1,
        "created_at": "2019-03-08T19:47:01.128Z",
        "updated_at": "2019-03-08T19:47:01.164Z"
    },
    {
        "id": 2,
        "state_type_id": 2,
        "name": "open",
        "next_state_id": null,
        "ignore_escalation": false,
        "default_create": false,
        "default_follow_up": true,
        "note": null,
        "active": true,
        "updated_by_id": 1,
        "created_by_id": 1,
        "created_at": "2019-03-08T19:47:01.153Z",
    .....
    }

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("http://your_domain_name/api/v1/ticket_states")
  .get()
  .addHeader("Authorization", "Basic bbh3WEWNhQGRhdGFhZWdpcy5jb206TW9uaWNHU6txMjM0")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://your_domain_name/api/v1/ticket_states",
  "method": "GET",
  "headers": {
    "Authorization": "Basic bhyDRWNhQGRhdGFhZWdpcy5jb206TW9uaWNH7UAxMjM0",
    "cache-control": "no-cache",
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

<?php

$request = new HttpRequest();
$request->setUrl('http://your_domain_name/api/v1/ticket_states');
$request->setMethod(HTTP_METH_GET);

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'Authorization' => 'Basic bhYG6WNhQGRhdGFhZWdpcy5jb206TW9uaWhuG6AxMjM0'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

import requests

url = "http://your_domain_name/api/v1/ticket_states"

payload = ""
headers = {
    'Authorization': "Basic bhgYFWNhQGRhdGFhZWdpcy5jb206TW9nhuNhX0AxMjM0",
    'cache-control': "no-cache",
    }

response = requests.request("GET", url, data=payload, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

url = URI("http://your_domain_name/api/v1/ticket_states")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic bhgyEWNhQGRhdGFhZWdpcy5jb206TW7UHWNhX0AxMjM0'
request["cache-control"] = 'no-cache'

response = http.request(request)
puts response.read_body

curl --request GET \
  --url http://your_domain_name/api/v1/ticket_states \
  --header 'Authorization: Basic VGyu7WNhQGRhdGFhZWdpcy5jb206TnjU7aWNhX0AxMjM0' \
  --header 'cache-control: no-cache'

Get a list of ticket states.

Required permission

admin.object (can read all ticket states)
ticket.agent (can read all ticket states)
ticket.customer (can read all ticket states)

HTTP Request

GET /api/v1/ticket_states

Response

Expected Response Code: 200

Show

{
    "id": 2,
    "state_type_id": 2,
    "name": "open",
    "next_state_id": null,
    "ignore_escalation": false,
    "default_create": false,
    "default_follow_up": true,
    "note": null,
    "active": true,
    "updated_by_id": 1,
    "created_by_id": 1,
    "created_at": "2019-03-08T19:47:01.153Z",
    "updated_at": "2019-03-08T19:47:01.153Z"
}

curl --request GET \
  --url http://your_domain_name/api/v1/ticket_states/2 \
  --header 'Authorization: Basic bhyEFWNhQGRhdGFhZWdpcy5jb206bhYuaWNhX0AxMjM0' \
  --header 'cache-control: no-cache'

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("http://your_domain_name/api/v1/ticket_states/2")
  .get()
  .addHeader("Authorization", "Basic bhGYTWNhQGRhdGFhZWdpcy5jb206TNJH7uWNhX0AxMjM0")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://your_domain_name/api/v1/ticket_states/2",
  "method": "GET",
  "headers": {
    "Authorization": "Basic bhgY6WNhQGRhdGFhZWdpcy5jb206TWnj7WNhX0AxMjM0",
    "cache-control": "no-cache",
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

<?php

$request = new HttpRequest();
$request->setUrl('http://your_domain_name/api/v1/ticket_states/2');
$request->setMethod(HTTP_METH_GET);

$request->setHeaders(array(

  'cache-control' => 'no-cache',
  'Authorization' => 'Basic bhy67WNhQGRhdGFhZWdpcy5jb206TWnj7WNhX0AxMjM0'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

import requests

url = "http://your_domain_name/api/v1/ticket_states/2"

payload = ""
headers = {
    'Authorization': "Basic nhuS3WNhQGRhdGFhZWdpcy5jb206TW9uaWNhX0AxMjM0",
    'cache-control': "no-cache",

    }

response = requests.request("GET", url, data=payload, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

url = URI("http://your_domain_name/api/v1/ticket_states/2")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic bhF56WNhQGRhdGFhZWdpcy5jb206TW9uNH7hX0AxMjM0'
request["cache-control"] = 'no-cache'

response = http.request(request)
puts response.read_body

Displays a ticket state information using id attribute.

Required permission

admin.object (can read all ticket states)
ticket.agent (can read all ticket states)
ticket.customer (can read all ticket states)

HTTP Request

GET /api/v1/ticket_states/{id}

Response

Expected Response Code: 200

Create

{
    "id": 8,
    "state_type_id": 1,
    "name": "Ticket State 1",
    "next_state_id": null,
    "ignore_escalation": true,
    "default_create": false,
    "default_follow_up": false,
    "note": "some note",
    "active": true,
    "updated_by_id": 5,
    "created_by_id": 5,
    "created_at": "2019-03-15T05:53:08.348Z",
    "updated_at": "2019-03-15T05:53:08.348Z"
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\r\n \"name\": \"Ticket State 1\",\r\n \"state_type_id\": 1,\r\n \"next_state_id\": null,\r\n \"ignore_escalation\": true,\r\n \"active\": true,\r\n \"note\": \"some note\"\r\n}");
Request request = new Request.Builder()
  .url("http://your_domain_name/api/v1/ticket_states")
  .post(body)
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Basic bhGY7WNhQGRhdGFhZWdpcy5jb206TWnjhU7NhX0AxMjM0")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://your_domain_name/api/v1/ticket_states",
  "method": "POST",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Basic nhy34WNhQGRhdGFhZWdpcy5jb206TWnhy6WNhX0AxMjM0",
    "cache-control": "no-cache",
  },
  "processData": false,
  "data": "{\r\n \"name\": \"Ticket State 1\",\r\n \"state_type_id\": 1,\r\n \"next_state_id\": null,\r\n \"ignore_escalation\": true,\r\n \"active\": true,\r\n \"note\": \"some note\"\r\n}"
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

<?php

$request = new HttpRequest();
$request->setUrl('http://your_domain_name/api/v1/ticket_states');
$request->setMethod(HTTP_METH_POST);

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'Authorization' => 'Basic nhyWNhQGRh5dGFhZWdpcy5jb206TW9uaWNhX0AxMjM0',
  'Content-Type' => 'application/json'
));

$request->setBody('{
 "name": "Ticket State 1",
 "state_type_id": 1,
 "next_state_id": null,
 "ignore_escalation": true,
 "active": true,
 "note": "some note"
}');

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

import requests

url = "http://your_domain_name/api/v1/ticket_states"

payload = "{\r\n \"name\": \"Ticket State 1\",\r\n \"state_type_id\": 1,\r\n \"next_state_id\": null,\r\n \"ignore_escalation\": true,\r\n \"active\": true,\r\n \"note\": \"some note\"\r\n}"
headers = {
    'Content-Type': "application/json",
    'Authorization': "Basic nhYt6WNhQGRhdGFhZWdpcy8hb206TW9uaWNhX0AxMjM0",
    'cache-control': "no-cache",
    }

i\response = requests.request("POST", url, data=payload, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

url = URI("http://your_domain_name/api/v1/ticket_states")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request["Authorization"] = 'Basic nhyFRWNhQGRhdGFhZWdpcy5jBG66TW9uaWNhX0AxMjM0'
request["cache-control"] = 'no-cache'
request.body = "{\r\n \"name\": \"Ticket State 1\",\r\n \"state_type_id\": 1,\r\n \"next_state_id\": null,\r\n \"ignore_escalation\": true,\r\n \"active\": true,\r\n \"note\": \"some note\"\r\n}"

response = http.request(request)
puts response.read_body

curl --request POST \
  --url http://your_domain_name/api/v1/ticket_states \
  --header 'Authorization: Basic bhyFRWNhQGRhdGFhZWdpcy5jb206TW87yWNhX0AxMjM0' \
  --header 'Content-Type: application/json' \
  --header 'cache-control: no-cache' \
  --data '{\r\n "name": "Ticket State 1",\r\n "state_type_id": 1,\r\n "next_state_id": null,\r\n "ignore_escalation": true,\r\n "active": true,\r\n "note": "some note"\r\n}'

Creates a new ticket state.

Required permission

admin.object

HTTP Request

POST /api/v1/ticket_states

Response

Expected Response Code: 200

Update

{
    "id": 2,
    "name": "open",
    "state_type_id": 2,
    "next_state_id": null,
    "ignore_escalation": false,
    "default_create": false,
    "default_follow_up": true,
    "note": null,
    "active": true,
    "updated_by_id": 5,
    "created_by_id": 1,
    "created_at": "2019-03-08T19:47:01.153Z",
    "updated_at": "2019-03-08T19:47:01.153Z"
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("http://your_domain_name/api/v1/ticket_states/2")
  .put(null)
  .addHeader("Authorization", "Basic nhyer5NhQGRhdGFhZWdpcy5jb206TnhyaWNhX0AxMjM0")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://your_domain_name/api/v1/ticket_states/2",
  "method": "PUT",
  "headers": {
    "Authorization": "Basic nhy67njuQGRhdGFhZWdpcy5jb206TW9uaWNhX0AxMjM0",
    "cache-control": "no-cache",
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

<?php

$request = new HttpRequest();
$request->setUrl('http://your_domain_name/api/v1/ticket_states/2');
$request->setMethod(HTTP_METH_PUT);

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'Authorization' => 'Basic nhy62WNhQGRhdGFhZWdpcy5jb206TWnj9WNhX0AxMjM0'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

import requests

url = "http://your_domain_name/api/v1/ticket_states/2"

payload = ""
headers = {
    'Authorization': "Basic kdfioNhQGRhdGFhZWdpcy5jb206TW9ualddX0AxMjM0",
    'cache-control': "no-cache",
    }

response = requests.request("PUT", url, data=payload, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

url = URI("http://your_domain_name/api/v1/ticket_states/2")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Basic maud1iaoQGRhdGFhZWdpcy5jb206TW9uaWNhX0AxMjM0'
request["cache-control"] = 'no-cache'

response = http.request(request)
puts response.read_body

curl --request PUT \
  --url http://your_domain_name/api/v1/ticket_states/2 \
  --header 'Authorization: Basic msd78WNhQGRhdGFhZWdpcy5jb206TW9uaWNhX0AxMjM0' \

  --header 'cache-control: no-cache'

Update a ticket state using Attribute id.

Required permission

admin.object

HTTP Request

PUT /api/v1/ticket_states/{id}

Response

Expected Response code: 200

Delete

{}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("http://your_domain_name/api/v1/ticket_states/2")
  .delete(null)
  .addHeader("cache-control", "no-cache")
   .build();

Response response = client.newCall(request).execute();

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://your_domain_name/api/v1/ticket_states/1",
  "method": "DELETE",
  "headers": {
    "Authorization": "Basic c2hpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    "cache-control": "no-cache",

  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

<?php

$request = new HttpRequest();
$request->setUrl('http://your_domain_name/api/v1/ticket_states/1');
$request->setMethod(HTTP_METH_DELETE);

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'Authorization' => 'Basic nhay67hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

require 'uri'
require 'net/http'

url = URI("http://your_domain_name/api/v1/ticket_states/1")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Basic nh8pa2jiQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0'
request["cache-control"] = 'no-cache'
response = http.request(request)
puts response.read_body

import requests

url = "http://your_domain_name/api/v1/ticket_states/1"

payload = ""
headers = {
    'Authorization': "Basic nju7892hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    'cache-control': "no-cache",

    }

response = requests.request("DELETE", url, data=payload, headers=headers)

print(response.text)

curl --request DELETE \
  --url http://your_domain_name/api/v1/ticket_states/1 \
  --header 'Authorization: Basic nhy782hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0' \

  --header 'cache-control: no-cache'

Delete a ticket state using id attribute.

Required permission

admin.object (only if no references in history tables and tickets exist)

HTTP Request

DELETE /api/v1/ticket_states/{id}

Response

Expected response code: 200

Ticket Priority

List

[
    {
        "id": 1,
        "name": "1 low",
        "default_create": false,
        "note": null,
        "active": true,
        "updated_by_id": 1,
        "created_by_id": 1,
        "created_at": "2019-03-08T19:47:01.259Z",
        "updated_at": "2019-03-08T19:47:01.287Z"
    },
    {
        "id": 2,
        "name": "2 normal",
        "default_create": true,
        "note": null,
        "active": true,
        "updated_by_id": 1,
        "created_by_id": 1,
        "created_at": "2019-03-08T19:47:01.278Z",
        "updated_at": "2019-03-08T19:47:01.278Z"
    },
    {
        "id": 3,
        "name": "3 high",
        "default_create": false,
        "note": null,
        "active": true,
        "updated_by_id": 1,
        "created_by_id": 1,
        "created_at": "2019-03-08T19:47:01.296Z",
        "updated_at": "2019-03-08T19:47:01.296Z"
    }
]

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("http://your_domain_name/api/v1/ticket_priorities")
  .get()
  .addHeader("Authorization", "Basic njdus82hhQGRhdGFhZWdpcy5jb206U2kis2hhX0AxMjM0")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://your_domain_name/api/v1/ticket_priorities",
  "method": "GET",
  "headers": {
    "Authorization": "Basic nsjdu12hhQGRhdGFhZWdpcy5jb206U2hdsi2hhX0AxMjM0",
    "cache-control": "no-cache",

  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

<?php

$request = new HttpRequest();
$request->setUrl('http://your_domain_name/api/v1/ticket_priorities');
$request->setMethod(HTTP_METH_GET);

$request->setHeaders(array(

  'cache-control' => 'no-cache',
  'Authorization' => 'Basic njaoa2hhQGRhdGFhZWdpcy5jb206U2hpa2hh0aAxMjM0'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

import requests

url = "http://your_domain_name/api/v1/ticket_priorities"

payload = ""
headers = {
    'Authorization': "Basic nsuia23hQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    'cache-control': "no-cache",
    'Postman-Token': "a239bb62-ddaf-4d02-b087-9c1c82d134b1"
    }

response = requests.request("GET", url, data=payload, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

url = URI("http://your_domain_name/api/v1/ticket_priorities")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic nhys32hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0'
request["cache-control"] = 'no-cache'

response = http.request(request)
puts response.read_body

curl --request GET \
  --url http://your_domain_name/api/v1/ticket_priorities \
  --header 'Authorization: Basic akjs22hhQGRhdGFhZWdpcy5aks06U2hpa2hhX0AxMjM0' \
  --header 'cache-control: no-cache'

This endpoint is used to get the list of Ticket Priorities.

Required permission

admin.object (can read all ticket states)
ticket.agent (can read all ticket states)
ticket.customer (can read all ticket states)

HTTP Request

GET /api/v1/ticket_priorities

Response

Expected Response Code: 200

Show

{
    "id": 2,
    "name": "2 normal",
    "default_create": true,
    "note": null,
    "active": true,
    "updated_by_id": 1,
    "created_by_id": 1,
    "created_at": "2019-03-08T19:47:01.278Z",
    "updated_at": "2019-03-08T19:47:01.278Z"
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("http://your_domain_name/api/v1/ticket_priorities/2")
  .get()
  .addHeader("Authorization", "Basic asie22hhQGRhdGFhZWdpcy5jb206U2ala2hhX0AxMjM0")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://your_domain_name/api/v1/ticket_priorities/2",
  "method": "GET",
  "headers": {
    "Authorization": "Basic aslo32hhQGRhdGFhZWdpcy5jb20302hpa2hhX0AxMjM0",
    "cache-control": "no-cache",
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

<?php

$request = new HttpRequest();
$request->setUrl('http://your_domain_name/api/v1/ticket_priorities/2');
$request->setMethod(HTTP_METH_GET);

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'Authorization' => 'Basic nhdy32hhQGRhdGFhZWdpcy5jb206Ualoa2hhX0AxMjM0'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

import requests

url = "http://your_domain_name/api/v1/ticket_priorities/2"

payload = ""
headers = {
    'Authorization': "Basic skid22hhQGRhdGFhZWdpcy5jb206U120pa2hhX0AxMjM0",
    'cache-control': "no-cache",
    }

response = requests.request("GET", url, data=payload, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

url = URI("http://your_domain_name/api/v1/ticket_priorities/2")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic asl352hhQGRhdGFhZWdpcy5jb206U2hok2hhX0AxMjM0'
request["cache-control"] = 'no-cache'

response = http.request(request)
puts response.read_body

curl --request GET \
  --url http://your_domain_name/api/v1/ticket_priorities/2 \
  --header 'Authorization: Basic kdhs32hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0' \
  --header 'cache-control: no-cache'

Get a list of ticket priorities as per the id attribute.

Required Permission

admin.object (can read all ticket states)
ticket.agent (can read all ticket states)
ticket.customer (can read all ticket states)

HTTP Request

GET /api/v1/ticket_priorities/{id}

Response

Expected Response Code: 200

Create

{
    "id": 4,
    "name": "Ticket Priority 1",
    "default_create": false,
    "note": "some note",
    "active": true,
    "updated_by_id": 5,
    "created_by_id": 5,
    "created_at": "2019-03-15T06:47:29.467Z",
    "updated_at": "2019-03-15T06:47:29.467Z"
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\r\n \"name\": \"Ticket Priority 1\",\r\n \"active\": true,\r\n \"note\": \"some note\"\r\n}");
Request request = new Request.Builder()
  .url("http://your_domain_name/api/v1/ticket_priorities")
  .post(body)
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Basic cas342hhQGRhdGFhZWdpcy5jb206U20oka2hhX0AxMjM0")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://your_domain_name/api/v1/ticket_priorities",
  "method": "POST",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Basic asj232hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    "cache-control": "no-cache",
  },
  "processData": false,
  "data": "{\r\n \"name\": \"Ticket Priority 1\",\r\n \"active\": true,\r\n \"note\": \"some note\"\r\n}"
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

<?php

$request = new HttpRequest();
$request->setUrl('http://your_domain_name/api/v1/ticket_priorities');
$request->setMethod(HTTP_METH_POST);

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'Authorization' => 'Basic amjf32hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0',
  'Content-Type' => 'application/json'
));

$request->setBody('{
 "name": "Ticket Priority 1",
 "active": true,
 "note": "some note"
}');

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

import requests

url = "http://your_domain_name/api/v1/ticket_priorities"

payload = "{\r\n \"name\": \"Ticket Priority 1\",\r\n \"active\": true,\r\n \"note\": \"some note\"\r\n}"
headers = {
    'Content-Type': "application/json",
    'Authorization': "Basic sdd342hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    'cache-control': "no-cache",
    }

response = requests.request("POST", url, data=payload, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

url = URI("http://your_domain_name/api/v1/ticket_priorities")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request["Authorization"] = 'Basic kau322hhQGRhdGFhZWdpcy5jb206U2hpa2h0opAxMjM0'
request["cache-control"] = 'no-cache'
request.body = "{\r\n \"name\": \"Ticket Priority 1\",\r\n \"active\": true,\r\n \"note\": \"some note\"\r\n}"

response = http.request(request)
puts response.read_body

curl --request POST \
  --url http://your_domain_name/api/v1/ticket_priorities \
  --header 'Authorization: Basic ansiw2hhQGRhdGFhZWdpcy5jb206Ulaoa2hhX0AxMjM0' \
  --header 'Content-Type: application/json' \
  --header 'cache-control: no-cache' \
  --data '{\r\n "name": "Ticket Priority 1",\r\n "active": true,\r\n "note": "some note"\r\n}'

Creates a Ticket Priority.

Required permission

admin.object

HTTP Request

POST /api/v1/ticket_priorities

Response

Expected Response Code: 200

Update

{
    "id": 1,
    "name": "1 low",
    "default_create": false,
    "note": null,
    "active": true,
    "updated_by_id": 5,
    "created_by_id": 1,
    "created_at": "2019-03-08T19:47:01.259Z",
    "updated_at": "2019-03-08T19:47:01.287Z"
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("http://your_domain_name/api/v1/ticket_priorities/1")
  .put(null)
  .addHeader("Authorization", "Basic asuk32hhQGRhdGFhZWdpcy5jb206U2hpa2poX0AxMjM0")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://your_domain_name/api/v1/ticket_priorities/1",
  "method": "PUT",
  "headers": {
    "Authorization": "Basic wekdr2hhQGRhdGFhZWdpcy5jb206U2xkma2hhX0AxMjM0",
    "cache-control": "no-cache",

  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

<?php

$request = new HttpRequest();
$request->setUrl('http://your_domain_name/api/v1/ticket_priorities/1');
$request->setMethod(HTTP_METH_PUT);

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'Authorization' => 'Basic najsy2hhQGRhdGFhZWdpcy5jb2paU2hpa2hhX0AxMjM0'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

import requests

url = "http://your_domain_name/api/v1/ticket_priorities/1"

payload = ""
headers = {
    'Authorization': "Basic ansh32hhQGRhdGFhZWdpcy5ak206U2hpa2hhX0AxMjM0",
    'cache-control': "no-cache",
    }

response = requests.request("PUT", url, data=payload, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

url = URI("http://your_domain_name/api/v1/ticket_priorities/1")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Basic akio22hhQGRhdGFhZWdpcy5jb206pohpa2hhX0AxMjM0'
request["cache-control"] = 'no-cache'

response = http.request(request)
puts response.read_body

curl --request PUT \
  --url http://your_domain_name/api/v1/ticket_priorities/1 \
  --header 'Authorization: Basic maioe2hhQGRhdGFhZWdpcy5jb20nan2hpa2hhX0AxMjM0' \
  --header 'cache-control: no-cache'

Updates the Ticket priorities using attribute id.

Required permission

admin.object

HTTP Request

PUT /api/v1/ticket_priorities/{id}

Response

Expected Response Code: 200

Delete

{}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("http://your_domain_name/api/v1/ticket_priorities/1")
  .delete(null)
  .addHeader("Authorization", "Basic moanj2hhQGRhdGFhZWdpcy5jb986U2hpa2hhX0AxMjM0")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://your_domain_name/api/v1/ticket_priorities/1",
  "method": "DELETE",
  "headers": {
    "Authorization": "Basic kail32hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    "cache-control": "no-cache",
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

<?php

$request = new HttpRequest();
$request->setUrl('http://your_domain_name/api/v1/ticket_priorities/1');
$request->setMethod(HTTP_METH_DELETE);

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'Authorization' => 'Basic msjd22hhQGRhdGFhZWdpcy5jop06U2hpa2hhX0AxMjM0'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

import requests

url = "http://your_domain_name/api/v1/ticket_priorities/1"

payload = ""
headers = {
    'Authorization': "Basic sdfr22hhQGRhdGFhZWdpcy5jb206U2hpa2hlo0AxMjM0",
    'cache-control': "no-cache",
    }

response = requests.request("DELETE", url, data=payload, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

url = URI("http://your_domain_name/api/v1/ticket_priorities/1")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Basic skaip2hhQGRhdGFhZWdpcy5jbopiU2hpa2hhX0AxMjM0'
request["cache-control"] = 'no-cache'

response = http.request(request)
puts response.read_body

curl --request DELETE \
  --url http://your_domain_name/api/v1/ticket_priorities/1 \
  --header 'Authorization: Basic asj342hhQGRhdGFhZWdpcy5jb206U2hpa2loX0AxMjM0' \
  --header 'cache-control: no-cache'

Deletes a Ticket priority using id value.

Required permission

admin.object (only if no references in history tables and tickets exist)

HTTP Request

DELETE /api/v1/ticket_priorities/{id}

Response

Expected Response code: 200

Ticket Article

By Ticket

{
        "id": 5,
        "ticket_id": 5,
        "type_id": 10,
        "sender_id": 1,
        "from": "shikha kumari",
        "to": "",
        "cc": "",
        "subject": "some subject",
        "reply_to": null,
        "message_id": null,
        "message_id_md5": null,
        "in_reply_to": null,
        "content_type": "text/html",
        "references": null,
        "body": "huhuhuu<br>huhuhuu<br>huhuhuu<br><br>",
        "internal": false,
        "preferences": {},
        "updated_by_id": 5,
        "created_by_id": 5,
        "origin_by_id": null,
        "created_at": "2019-03-15T07:26:45.043Z",
        "updated_at": "2019-03-15T07:26:45.043Z",
        "attachments": [],
        "type": "note",
        "sender": "Agent",
        "created_by": "shikha@dataaegis.com",
        "updated_by": "shikha@dataaegis.com"
    },
    {
        "id": 6,
        "ticket_id": 5,
        "type_id": 10,
        "sender_id": 1,
        "from": "Monica shree",
        "to": "",
        "cc": "",
        "subject": "some subject",
        "reply_to": null,
        "message_id": null,
        "message_id_md5": null,
        "in_reply_to": null,
        "content_type": "text/html",
        "references": null,
        "body": "huhuhuu<br>huhuhuu<br>huhuhuu<br><br>",
        "internal": false,
        "preferences": {},
        "updated_by_id": 6,
        "created_by_id": 6,
        "origin_by_id": null,
        "created_at": "2019-03-15T07:27:41.131Z",
        "updated_at": "2019-03-15T07:27:41.131Z",
        "attachments": [],
        "type": "note",
        "sender": "Agent",
        "created_by": "monica@dataaegis.com",
        "updated_by": "monica@dataaegis.com"
    }

 OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("http://your_domain_name/api/v1/ticket_articles/by_ticket/5")
  .get()
  .addHeader("Authorization", "Basic njuakWNhQGRhdGFhZWdpcy5jb206TW9uaWNhX0AxMjM0")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://your_domain_name/api/v1/ticket_articles/by_ticket/5",
  "method": "GET",
  "headers": {
    "Authorization": "Basic njaioWNhQGRhdGFhZWdpcy5jb2068io9uaWNhX0AxMjM0",
    "cache-control": "no-cache",
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

<?php

$request = new HttpRequest();
$request->setUrl('http://your_domain_name/api/v1/ticket_articles/by_ticket/5');
$request->setMethod(HTTP_METH_GET);

$request->setHeaders(array(
  'Postman-Token' => '8e623acc-9a4f-49a3-962b-c67d3f03a181',
  'cache-control' => 'no-cache',
  'Authorization' => 'Basic mdsi2WNhQGRhdGFhZWdpcy5jb206TW9uaWao900AxMjM0'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

import requests

url = "http://your_domain_name/api/v1/ticket_articles/by_ticket/5"

payload = ""
headers = {
    'Authorization': "Basic amso2WNhQGRhdGFhZWdpcy5jb200eW9uaWNhX0AxMjM0",
    'cache-control': "no-cache"
    }

response = requests.request("GET", url, data=payload, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

url = URI("http://your_domain_name/api/v1/ticket_articles/by_ticket/5")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic ajsi3WNhQGRhdGFhZWdpcy5jb206TW9uaWNhX0AxMjM0'
request["cache-control"] = 'no-cache'

response = http.request(request)
puts response.read_body

curl --request GET \
  --url http://your_domain_name/api/v1/ticket_articles/by_ticket/5 \
  --header 'Authorization: Basic pasorWNhQGRhdGFhZW92iy5jb206TW9uaWNhX0AxMjM0' \
  --header 'cache-control: no-cache'

Access the Ticket Article using Ticket id.

Required Permission

ticket.agent (access to related ticket)
ticket.customer (access to related ticket with customer_id ** current_user.id || organization_id ** current_user.organization_id)

HTTP Request

GET /api/v1/ticket_articles/by_ticket/{ticketId}

Response

Expected Response code: 200

Show

{
    "id": 4,
    "ticket_id": 5,
    "type_id": 10,
    "sender_id": 1,
    "from": "monica shree",
    "to": null,
    "cc": null,
    "subject": "some subject",
    "reply_to": null,
    "message_id": null,
    "message_id_md5": null,
    "in_reply_to": null,
    "content_type": "text/plain",
    "references": null,
    "body": "some message",
    "internal": false,
    "preferences": {},
    "updated_by_id": 5,
    "created_by_id": 5,
    "origin_by_id": null,
    "created_at": "2019-03-15T07:13:56.543Z",
    "updated_at": "2019-03-15T07:13:56.543Z",
    "attachments": [],
    "type": "note",
    "sender": "Agent",
    "created_by": "monica@dataaegis.com",
    "updated_by": "monica@dataaegis.com"
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("http://your_domain_name/api/v1/ticket_articles/4")
  .get()
  .addHeader("Authorization", "Basic jsdwq2hhQGRhdGFhZWdpcy5jb206hdyhpa2hhX0AxMjM0")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://your_domain_name/api/v1/ticket_articles/4",
  "method": "GET",
  "headers": {
    "Authorization": "Basic hgsh12hhQGRhdGFhZWdpcy5jb206U2poh3hhX0AxMjM0",
    "cache-control": "no-cache",
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

<?php

$request = new HttpRequest();
$request->setUrl('http://your_domain_name/api/v1/ticket_articles/4');
$request->setMethod(HTTP_METH_GET);

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'Authorization' => 'Basic sdbf32hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

import requests

url = "http://your_domain_name/api/v1/ticket_articles/4"

payload = ""
headers = {
    'Authorization': "Basic aksj32hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    'cache-control': "no-cache",
    }

response = requests.request("GET", url, data=payload, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

url = URI("http://your_domain_name/api/v1/ticket_articles/4")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic jbh42hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0'
request["cache-control"] = 'no-cache'

response = http.request(request)
puts response.read_body

curl --request GET \
  --url http://your_domain_name/api/v1/ticket_articles/4 \
  --header 'Authorization: Basic jhke22hhQGRhdGFhZWdpc04jb206U2hpa2hhX0AxMjM0' \
  --header 'cache-control: no-cache'

Displays a Ticket Article using id.

Required permission

ticket.agent (access to related ticket)
ticket.customer (access to related ticket with customer_id ** current_user.id || organization_id ** current_user.organization_id)

HTTP Request

GET /api/v1/ticket_articles/by_ticket/{ticketId}

Response

Expected Response Code: 200

Create

{
    "id": 6,
    "ticket_id": 5,
    "type_id": 10,
    "sender_id": 1,
    "from": "Monica shree",
    "to": "",
    "cc": "",
    "subject": "some subject",
    "reply_to": null,
    "message_id": null,
    "message_id_md5": null,
    "in_reply_to": null,
    "content_type": "text/html",
    "references": null,
    "body": "huhuhuu<br>huhuhuu<br>huhuhuu<br><br>",
    "internal": false,
    "preferences": {},
    "updated_by_id": 6,
    "created_by_id": 6,
    "origin_by_id": null,
    "created_at": "2019-03-15T07:27:41.131Z",
    "updated_at": "2019-03-15T07:27:41.131Z",
    "attachments": [],
    "type": "note",
    "sender": "Agent",
    "created_by": "monica@dataaegis.com",
    "updated_by": "monica@dataaegis.com"
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\r\n   \"ticket_id\": 5,\r\n   \"to\": \"\",\r\n   \"cc\": \"\",\r\n   \"subject\": \"some subject\",\r\n   \"body\": \"huhuhuu<br>huhuhuu<br>huhuhuu<br><br>\",\r\n   \"content_type\": \"text/html\",\r\n   \"type\": \"note\",\r\n   \"internal\": false,\r\n   \"time_unit\": \"12\"\r\n}");
Request request = new Request.Builder()
  .url("http://your_domain_name/api/v1/ticket_articles")
  .post(body)
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Basic oasidWNhQGRhdGFhZWdpcy5jb0289TW9uaWNhX0AxMjM0")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://your_domain_name/api/v1/ticket_articles",
  "method": "POST",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Basic vfhs4WNhQGRhdGFhZWdpcy5jb206TW9uiNhX0AxMjM0",
    "cache-control": "no-cache",
  },
  "processData": false,
  "data": "{\r\n   \"ticket_id\": 5,\r\n   \"to\": \"\",\r\n   \"cc\": \"\",\r\n   \"subject\": \"some subject\",\r\n   \"body\": \"huhuhuu<br>huhuhuu<br>huhuhuu<br><br>\",\r\n   \"content_type\": \"text/html\",\r\n   \"type\": \"note\",\r\n   \"internal\": false,\r\n   \"time_unit\": \"12\"\r\n}"
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

<?php

$request = new HttpRequest();
$request->setUrl('http://your_domain_name/api/v1/ticket_articles');
$request->setMethod(HTTP_METH_POST);

$request->setHeaders(array(

  'cache-control' => 'no-cache',
  'Authorization' => 'Basic fgds4WNhQGRhdGFhZWdpcy5jb473TW9uaWNhX0AxMjM0',
  'Content-Type' => 'application/json'
));

$request->setBody('{
   "ticket_id": 5,
   "to": "",
   "cc": "",
   "subject": "some subject",
   "body": "huhuhuu<br>huhuhuu<br>huhuhuu<br><br>",
   "content_type": "text/html",
   "type": "note",
   "internal": false,
   "time_unit": "12"
}');

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

import requests

url = "http://your_domain_name/api/v1/ticket_articles"

payload = "{\r\n   \"ticket_id\": 5,\r\n   \"to\": \"\",\r\n   \"cc\": \"\",\r\n   \"subject\": \"some subject\",\r\n   \"body\": \"huhuhuu<br>huhuhuu<br>huhuhuu<br><br>\",\r\n   \"content_type\": \"text/html\",\r\n   \"type\": \"note\",\r\n   \"internal\": false,\r\n   \"time_unit\": \"12\"\r\n}"
headers = {
    'Content-Type': "application/json",
    'Authorization': "Basic hjds3WNhQGRhdGFhZWdpcy5jb206TW9uaWNhX0AxMjM0",
    'cache-control': "no-cache",
    }

response = requests.request("POST", url, data=payload, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

url = URI("http://your_domain_name/api/v1/ticket_articles")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request["Authorization"] = 'Basic jhs4bjNhQGRhdGFhZWdpcy5jb206TWjhaWNhX0AxMjM0'
request["cache-control"] = 'no-cache'
request.body = "{\r\n   \"ticket_id\": 5,\r\n   \"to\": \"\",\r\n   \"cc\": \"\",\r\n   \"subject\": \"some subject\",\r\n   \"body\": \"huhuhuu<br>huhuhuu<br>huhuhuu<br><br>\",\r\n   \"content_type\": \"text/html\",\r\n   \"type\": \"note\",\r\n   \"internal\": false,\r\n   \"time_unit\": \"12\"\r\n}"

response = http.request(request)
puts response.read_body

curl --request POST \
  --url http://your_domain_name/api/v1/ticket_articles \
  --header 'Authorization: Basic fhj443NhQGRhdGFhZWdpcy5jb20903ouaWNhX0AxMjM0' \
  --header 'Content-Type: application/json' \
  --header 'cache-control: no-cache' \
  --data '{\r\n   "ticket_id": 5,\r\n   "to": "",\r\n   "cc": "",\r\n   "subject": "some subject",\r\n   "body": "huhuhuu<br>huhuhuu<br>huhuhuu<br><br>",\r\n   "content_type": "text/html",\r\n   "type": "note",\r\n   "internal": false,\r\n   "time_unit": "12"\r\n}'

Creates a new Ticket Article.

Required permission

ticket.agent (access to related ticket)
ticket.customer (access to related ticket with customer_id ** current_user.id || organization_id ** current_user.organization_id)

HTTP Request

POST /api/v1/ticket_articles

Response

Expected Response Code: 200

User

me-current user

[
    {
        "id": 1,
        "organization_id": null,
        "login": "-",
        "firstname": "Bob",
        "lastname": "Smith",
        "email": "bob@smith.example.com",
        "image": null,
        "image_source": null,
        "web": "",
        "phone": "",
        "fax": "",
        "mobile": "",
        "department": "",
        "street": "",
        "zip": "",
        "city": "",
        "country": "",
        "address": "",
        "vip": false,
        "verified": false,
        "active": false,
        "note": "",
        "last_login": null,....
}

curl --request GET \
  --url http://your_domain_name/api/v1/users/me \
  --header 'Authorization: Basic sbvscrhhQGRhdGFhZWdpcy5jb206U2hpa2hhX0Axsdfg' \
  --header 'Content-Type: application/json'
  --header 'cache-control: no-cache'

<?php

$request = new HttpRequest();
$request->setUrl('http://your_domain_name/api/v1/users');
$request->setMethod(HTTP_METH_GET);

$request->setHeaders(array
  'cache-control' => 'no-cache',
  'Authorization' => 'Basic ertpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0',
  'Content-Type' => 'application/json'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("http://your_domain_name/api/v1/users")
  .get()
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Basic cdgha2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

require 'uri'
require 'net/http'

url = URI("http://your_domain_name/api/v1/users")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Content-Type"] = 'application/json'
request["Authorization"] = 'Basic fghpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0'
request["cache-control"] = 'no-cache'

response = http.request(request)
puts response.read_body

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://your_domain_name/api/v1/users",
  "method": "GET",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    "cache-control": "no-cache",
  },
  "processData": false,
  "data": ""
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

import requests

url = "http://your_domain_name/api/v1/users"

payload = ""
headers = {
    'Content-Type': "application/json",
    'Authorization': "Basic csdga2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    'cache-control': "no-cache",
    }

response = requests.request("GET", url, data=payload, headers=headers)

print(response.text)

Get the information of the current user.

Required permission:

Any(only valid authentication)

Http request

GET /api/v1/users/me

Response

Expected Response Code: 200

List

{
    "id": 10,
    "organization_id": null,
    "login": "bob@smit.com",
    "firstname": "shikha",
    "lastname": "Smih",
    "email": "bob@smit.com",
    "image": null,
    "image_source": null,
    "web": "",
    "phone": "",
    "fax": "",
    "mobile": "",
    "department": "",
    "street": "",
    "zip": "",
    "city": "",
    "country": "",
    "address": "",
    "vip": false,.....
}

curl --request GET \
  --url http://your_domain_name/api/v1/users \
  --header 'Authorization: Basic ghhpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0' \
  --header 'Content-Type: application/json' \
  --header 'cache-control: no-cache'

<?php

$request = new HttpRequest();
$request->setUrl('http://your_domain_name/api/v1/users');
$request->setMethod(HTTP_METH_GET);

$request->setHeaders(array(
  'Postman-Token' => '63ed3d12-fb23-407c-bbb9-7ad38d5ac979',
  'cache-control' => 'no-cache',
  'Authorization' => 'Basic hjkhpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0',
  'Content-Type' => 'application/json'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("http://your_domain_name/api/v1/users")
  .get()
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Basic chjka2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

require 'uri'
require 'net/http'

url = URI("http://your_domain_name/api/v1/users")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Content-Type"] = 'application/json'
request["Authorization"] = 'Basic jklpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0'
request["cache-control"] = 'no-cache'
response = http.request(request)
puts response.read_body

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://your_domain_name/api/v1/users",
  "method": "GET",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Basic hgjpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    "cache-control": "no-cache"
  },
  "processData": false,
  "data": ""
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

import requests

url = "http://your_domain_name/api/v1/users"

payload = ""
headers = {
    'Content-Type': "application/json",
    'Authorization': "Basic sdgpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    'cache-control': "no-cache",
    }

response = requests.request("GET", url, data=payload, headers=headers)

print(response.text)

Get the list of all users.

Required permission:

ticket.agent or admin.user (can read all users)
any (can only read its own user if exists)

Http Request:

GET /api/v1/users

Response

Expected Response Code: 200

Search

[
 {
   "id": 123,
   "firstname": "Bob",
   "lastname": "Smith",
   "email": "bob@smith.example.com",
   ...
   "note": "some note",
   "updated_at": "2016-08-16T07:55:42.119Z",
   "created_at": "2016-08-16T07:55:42.119Z"
 },
 {
   "id": 124,
   "firstname": "Martha",
   "lastname": "Braun",
   "email": "marta@braun.example.com",
   ...
   "note": "some note",
   "updated_at": "2016-08-16T07:55:42.119Z",
   "created_at": "2016-08-16T07:55:42.119Z"
 },
]

curl --request GET \
  --url 'http://your_domain_name/api/v1/users/search?id=3&limit=10' \
  --header 'Authorization: Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0' \
  --header 'cache-control: no-cache'

<?php

$request = new HttpRequest();
$request->setUrl('http://your_domain_name/api/v1/users/search');
$request->setMethod(HTTP_METH_GET);

$request->setQueryData(array(
  'id' => '3',
  'limit' => '10'
));

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'Authorization' => 'Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://your_domain_name/api/v1/users/search?id=3&limit=10",
  "method": "GET",
  "headers": {
    "Authorization": "Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    "cache-control": "no-cache",
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("http://your_domain_name/api/v1/users/search?id=3&limit=10")
  .get()
  .addHeader("Authorization", "Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

require 'uri'
require 'net/http'

url = URI("http://your_domain_name/api/v1/users/search?id=3&limit=10")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0'
request["cache-control"] = 'no-cache'

response = http.request(request)
puts response.read_body

import requests

url = "http://your_domain_name/api/v1/users/search"

querystring = {"id":"3","limit":"10"}

payload = ""
headers = {
    'Authorization': "Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    'cache-control': "no-cache",
    }

response = requests.request("GET", url, data=payload, headers=headers, params=querystring)

print(response.text)

Search user using any attribute.

Required permission:

ticket.agent or admin.user (can read all users)

Http Request:

GET /api/v1/users/search?query=what&limit=10

Here, query - is any attribute of User what - value of that attribute

Note: As of Aritic Desk parameters (sort_by=some_row and order_by=asc or desc) can also be used for sorting.

Response

Expected response code:200

Show

{
    "id": 1,
    "organization_id": null,
    "login": "-",
    "firstname": "Bob",
    "lastname": "Smith",
    "email": "bob@smith.example.com",
    "image": null,
    "image_source": null,
    "web": "",
    "phone": "",
    "fax": "",
    "mobile": "",
    "department": "",
    "street": "",
    "zip": "",
    "city": "",
    "country": "",
    "address": "",
    "vip": false,
    "verified": false,
    "active": false,
    "note": "",
    "last_login": null,
    "source": null,
    "login_failed": 0,
    "out_of_office": false,
    "out_of_office_start_at": null,
    "out_of_office_end_at": null,
    "out_of_office_replacement_id": null,
    "preferences": {},
    "updated_by_id": 5,
    "created_by_id": 1,
    "created_at": "2019-03-08T19:46:59.641Z",
    "updated_at": "2019-03-13T12:36:52.455Z",
    "role_ids": [
        3
    ],
    "organization_ids": [],
    "authorization_ids": [],
    "group_ids": {}
}

curl --request GET \
  --url http://your_domain_name/api/v1/users/3 \
  --header 'Authorization: Basic fghpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0' \
  --header 'cache-control: no-cache'

<?php

$request = new HttpRequest();
$request->setUrl('http://your_domain_name/api/v1/users/3');
$request->setMethod(HTTP_METH_GET);

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'Authorization' => 'Basic dfgpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("http://your_domain_name/api/v1/users/3")
  .get()
  .addHeader("Authorization", "Basic dfgha2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

require 'uri'
require 'net/http'

url = URI("http://your_domain_name/api/v1/users/3")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic cdfga2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0'
request["cache-control"] = 'no-cache

response = http.request(request)
puts response.read_body

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://your_domain_name/api/v1/users/3",
  "method": "GET",
  "headers": {
    "Authorization": "Basic cdfga2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    "cache-control": "no-cache",
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

import requests

url = "http://your_domain_name/api/v1/users/3"

payload = ""
headers = {
    'Authorization': "Basic ghjpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    'cache-control': "no-cache",
    }

response = requests.request("GET", url, data=payload, headers=headers)

print(response.text)

Displays a user information using id attribute.

Required permission:

ticket.agent or admin.user (can read all users)
customer with same organization (can read all users of same organization)
any (can only read it’s own user if exists)

Http Request:

GET /api/v1/users/{id}

Response

Expected Response Code: 200

Create

{
    "id": 9,
    "organization_id": null,
    "login": "bob@smith.com",
    "firstname": "shikha",
    "lastname": "Smith",
    "email": "bob@smith.com",
    "image": null,
    "image_source": null,
    "web": "",
    "phone": "",
    "fax": "",
    "mobile": "",
    "department": "",
    "street": "",
    "zip": "",
    "city": "",
    "country": "",
    "address": "",
    "vip": false,
    "verified": false,
    "active": true,
    "note": "",
    "last_login": null,
    "source": null,
    "login_failed": 0,
    "out_of_office": false,
    "out_of_office_start_at": null,
    "out_of_office_end_at": null,
    "out_of_office_replacement_id": null,
    "preferences": {
        "locale": "en-us"
    },
    "updated_by_id": 5,
    "created_by_id": 5,
    "created_at": "2019-03-13T12:52:01.954Z",
    "updated_at": "2019-03-13T12:52:01.954Z",
    "role_ids": [
        3
    ],
    "organization_ids": [],
    "authorization_ids": [],
}

curl --request POST \
  --url http://your_domain_name/api/v1/users \
  --header 'Authorization: Basic jklpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0' \
  --header 'Content-Type: application/json' \
  --header 'cache-control: no-cache' \
  --data '{\r\n "firstname": "shikha",\r\n "lastname": "Smith",\r\n "email": "bob@smith.com"\r\n}'

<?php

$request = new HttpRequest();
$request->setUrl('http://your_domain_name/api/v1/users');
$request->setMethod(HTTP_METH_POST);

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'Authorization' => 'Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0',
  'Content-Type' => 'application/json'
));

$request->setBody('{
 "firstname": "shikha",
 "lastname": "Smith",
 "email": "bob@smith.com"
}');

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\r\n \"firstname\": \"shikha\",\r\n \"lastname\": \"Smith\",\r\n \"email\": \"bob@smith.com\"\r\n}");
Request request = new Request.Builder()
  .url("http://your_domain_name/api/v1/users")
  .post(body)
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Basic jklpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

require 'uri'
require 'net/http'

url = URI("http://your_domain_name/api/v1/users")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request["Authorization"] = 'Basic jklpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0'
request["cache-control"] = 'no-cache'
request.body = "{\r\n \"firstname\": \"shikha\",\r\n \"lastname\": \"Smith\",\r\n \"email\": \"bob@smith.com\"\r\n}"

response = http.request(request)
puts response.read_body

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://your_domain_name/api/v1/users",
  "method": "POST",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    "cache-control": "no-cache",
  },
  "processData": false,
  "data": "{\r\n \"firstname\": \"shikha\",\r\n \"lastname\": \"Smith\",\r\n \"email\": \"bob@smith.com\"\r\n}"
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

import requests

url = "http://your_domain_name/api/v1/users"

payload = "{\r\n \"firstname\": \"shikha\",\r\n \"lastname\": \"Smih\",\r\n \"email\": \"bob@smit.com\"\r\n}"
headers = {
    'Content-Type': "application/json",
    'Authorization': "Basic jklpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    'cache-control': "no-cache",
    }

response = requests.request("POST", url, data=payload, headers=headers)

print(response.text)

Create a new user.

Required permission:

admin.user
ticket.agent (can not set roles/role_ids and not set groups/group_ids - roles.default_at_signup roles will get assigned automatically)
any - until user_create_account is disabled (can not set roles/role_ids and not set groups/group_ids - roles.default_at_signup roles will get assigned automatically)

Http Request:

POST /api/v1/users

Response

Expected Response Code: 200

Update

{
    "id": 1,
    "organization_id": null,
    "login": "-",
    "firstname": "Bob",
    "lastname": "Smith",
    "email": "bob@smith.example.com",
    "image": null,
    "image_source": null,
    "web": "",
    "phone": "",
    "fax": "",
    "mobile": "",
    "department": "",
    "street": "",
    "zip": "",
    "city": "",
    "country": "",
    "address": "",
    "vip": false,
    "verified": false,
    "active": false,
    "note": "",
    "last_login": null,
    "source": null,
    "login_failed": 0,
    "out_of_office": false,
    "out_of_office_start_at": null,
    "out_of_office_end_at": null,
    "out_of_office_replacement_id": null,
    "preferences": {},
    "updated_by_id": 5,
    "created_by_id": 1,
    "created_at": "2019-03-08T19:46:59.641Z",
    "updated_at": "2019-03-13T12:36:52.455Z",
    "role_ids": [
        3
    ],
    "organization_ids": [],
    "authorization_ids": [],
    "group_ids": {}
}

curl --request PUT \
  --url http://your_domain_name/api/v1/users/5 \
  --header 'Authorization: Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0' \
  --header 'Content-Type: application/json' \
  --header 'cache-control: no-cache' \
  --data '{\r\n "firstname": "shikha",\r\n "lastname": "kumari",\r\n "email": "shikha@dataaegis.com"\r\n}'

<?php

$request = new HttpRequest();
$request->setUrl('http://your_domain_name/api/v1/users/5');
$request->setMethod(HTTP_METH_PUT);

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'Authorization' => 'Basic shjpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0',
  'Content-Type' => 'application/json'
));

$request->setBody('{
 "firstname": "shikha",
 "lastname": "kumari",
 "email": "shikha@dataaegis.com"
}');

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\r\n \"firstname\": \"shikha\",\r\n \"lastname\": \"kumari\",\r\n \"email\": \"shikha@dataaegis.com\"\r\n}");
Request request = new Request.Builder()
  .url("http://your_domain_name/api/v1/users/5")
  .put(body)
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

require 'uri'
require 'net/http'

url = URI("http://your_domain_name/api/v1/users/5")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request["Authorization"] = 'Basic dfgpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0'
request["cache-control"] = 'no-cache'
request.body = "{\r\n \"firstname\": \"shikha\",\r\n \"lastname\": \"kumari\",\r\n \"email\": \"shikha@dataaegis.com\"\r\n}"

response = http.request(request)
puts response.read_body

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://your_domain_name/api/v1/users/5",
  "method": "PUT",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    "cache-control": "no-cache",
  },
  "processData": false,
  "data": "{\r\n \"firstname\": \"shikha\",\r\n \"lastname\": \"kumari\",\r\n \"email\": \"shikha@dataaegis.com\"\r\n}"
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

import requests

url = "http://your_domain_name/api/v1/users/5"

payload = "{\r\n \"firstname\": \"shikha\",\r\n \"lastname\": \"kumari\",\r\n \"email\": \"shikha@dataaegis.com\"\r\n}"
headers = {
    'Content-Type': "application/json",
    'Authorization': "Basic ghjpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    'cache-control': "no-cache",
    }

response = requests.request("PUT", url, data=payload, headers=headers)

print(response.text)

Update the user.

Required permission:

admin.user
ticket.agent (can only update customer accounts and not set roles/role_ids and not set groups/group_ids - already assigned attributes will not changed)

HTTP Request

PUT /api/v1/users/{id}

Response

Expected Response Code: 200

Delete

{}

curl --request DELETE \
  --url http://your_domain_name/api/v1/users/10 \
  --header 'Authorization: Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0' \
  --header 'Content-Type: application/json' \
  --header 'cache-control: no-cache' \
  --data '{\r\n "firstname": "shikha",\r\n "lastname": "Smih",\r\n "email": "bob@smit.com"\r\n}'

<?php

$request = new HttpRequest();
$request->setUrl('http://your_domain_name/api/v1/users/10');
$request->setMethod(HTTP_METH_DELETE);

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'Authorization' => 'Basic jklpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0',
  'Content-Type' => 'application/json'
));

$request->setBody('{
 "firstname": "shikha",
 "lastname": "Smih",
 "email": "bob@smit.com"
}');

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\r\n \"firstname\": \"shikha\",\r\n \"lastname\": \"Smih\",\r\n \"email\": \"bob@smit.com\"\r\n}");
Request request = new Request.Builder()
  .url("http://your_domain_name/api/v1/users/10")
  .delete(body)
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

require 'uri'
require 'net/http'

url = URI("http://your_domain_name/api/v1/users/10")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Delete.new(url)
request["Content-Type"] = 'application/json'
request["Authorization"] = 'Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0'
request["cache-control"] = 'no-cache'
request.body = "{\r\n \"firstname\": \"shikha\",\r\n \"lastname\": \"Smih\",\r\n \"email\": \"bob@smit.com\"\r\n}"

response = http.request(request)
puts response.read_body

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://your_domain_name/api/v1/users/10",
  "method": "DELETE",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    "cache-control": "no-cache",
  },
  "processData": false,
  "data": "{\r\n \"firstname\": \"shikha\",\r\n \"lastname\": \"Smih\",\r\n \"email\": \"bob@smit.com\"\r\n}"
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

import requests

url = "http://your_domain_name/api/v1/users/10"

payload = "{\r\n \"firstname\": \"shikha\",\r\n \"lastname\": \"Smih\",\r\n \"email\": \"bob@smit.com\"\r\n}"
headers = {
    'Content-Type': "application/json",
    'Authorization': "Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    'cache-control': "no-cache",
    }

response = requests.request("DELETE", url, data=payload, headers=headers)

print(response.text)

Delete a user using the ID.

Required Permission

admin.user (only if no references in history tables and tickets exist)

Http Request:

DELETE /api/v1/users/{id}

Response

Expected Response Code: 200

Organization

List

[
    {
        "id": 1,
        "name": "Data Aegis",
        "shared": true,
        "domain": "",
        "domain_assignment": false,
        "active": true,
        "note": "",
        "updated_by_id": 1,
        "created_by_id": 1,
        "created_at": "2019-03-08T19:47:01.565Z",
        "updated_at": "2019-03-08T19:48:59.957Z",
        "member_ids": [
            2
        ]
    }
]

curl --request GET \
  --url http://your_domain_name/api/v1/organizations \
  --header 'Authorization: Basic ghjpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0' 
  --header 'cache-control: no-cache'

<?php

$request = new HttpRequest();
$request->setUrl('http://your_domain_name/api/v1/organizations');
$request->setMethod(HTTP_METH_GET);

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'Authorization' => 'Basic ghjpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("http://your_domain_name/api/v1/organizations")
  .get()
  .addHeader("Authorization", "Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

require 'uri'
require 'net/http'

url = URI("http://your_domain_name/api/v1/organizations")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic dghpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0'
request["cache-control"] = 'no-cache

response = http.request(request)
puts response.read_body

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://your_domain_name/api/v1/organizations",
  "method": "GET",
  "headers": {
    "Authorization": "Basic dghpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    "cache-control": "no-cache",
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

import requests

url = "http://your_domain_name/api/v1/organizations"

payload = ""
headers = {
    'Authorization': "Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    'cache-control': "no-cache",
    }

response = requests.request("GET", url, data=payload, headers=headers)

print(response.text)

Get list of organization.

Required permission:

ticket.agent or admin.organization (can read all organizations)
any (can only read its own organization if exists)

Http Request

GET /api/v1/organizations

Response

Expected Response Code: 200

Search

[
 {
   "id": 123,
   "name": "Org 1",
   "shared": true,
   "active": true,
   "note": "some note",
   "updated_at": "2016-08-16T07:55:42.119Z",
   "created_at": "2016-08-16T07:55:42.119Z"
 },
 {
   "id": 124,
   "name": "Org 2",
   "shared": false,
   "active": true,
   "note": "some note",
   "updated_at": "2016-08-16T07:55:42.119Z",
   "created_at": "2016-08-16T07:55:42.119Z"
 },
]

curl --request GET \
  --url 'http://your_domain_name/api/v1/organizations/search?id=1&limit=10' \
  --header 'Authorization: Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0' \
  --header 'cache-control: no-cache'

<?php

$request = new HttpRequest();
$request->setUrl('http://your_domain_name/api/v1/organizations/search');
$request->setMethod(HTTP_METH_GET);

$request->setQueryData(array(
  'id' => '1',
  'limit' => '10'
));

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'Authorization' => 'Basic jklpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://your_domain_name/api/v1/organizations/search?id=1&limit=10",
  "method": "GET",
  "headers": {
    "Authorization": "Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    "cache-control": "no-cache",
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("http://your_domain_name/api/v1/organizations/search?id=1&limit=10")
  .get()
  .addHeader("Authorization", "Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

require 'uri'
require 'net/http'

url = URI("http://your_domain_name/api/v1/organizations/search?id=1&limit=10")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0'
request["cache-control"] = 'no-cache'

response = http.request(request)
puts response.read_body

import requests

url = "http://your_domain_name/api/v1/organizations/search"

querystring = {"id":"1","limit":"10"}

payload = ""
headers = {
    'Authorization': "Basic chjka2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    'cache-control': "no-cache",
    }

response = requests.request("GET", url, data=payload, headers=headers, params=querystring)

Search organization using any attribute.

Required permission:

ticket.agent or admin.organization (can read all organization)

Http Request

GET /api/v1/organizations/search?query=what&limit=10

Here, query - is any attribute of Organization what - value of that attribute

Response

Expected Response Code: 200

Show

{
    "id": 1,
    "name": "Data Aegis",
    "shared": true,
    "domain": "",
    "domain_assignment": false,
    "active": true,
    "note": "",
    "updated_by_id": 1,
    "created_by_id": 1,
    "created_at": "2019-03-08T19:47:01.565Z",
    "updated_at": "2019-03-08T19:48:59.957Z",
    "member_ids": [
        2
    ]
}

curl --request GET \
  --url http://your_domain_name/api/v1/organizations/1 \
  --header 'Authorization: Basic dfgpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0' \
  --header 'cache-control: no-cache'

<?php

$request = new HttpRequest();
$request->setUrl('http://your_domain_name/api/v1/organizations/1');
$request->setMethod(HTTP_METH_GET);

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'Authorization' => 'Basic dfgpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("http://your_domain_name/api/v1/organizations/1")
  .get()
  .addHeader("Authorization", "Basic dfgpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

require 'uri'
require 'net/http'

url = URI("http://your_domain_name/api/v1/organizations/1")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0'
request["cache-control"] = 'no-cache'
response = http.request(request)
puts response.read_body

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://your_domain_name/api/v1/organizations/1",
  "method": "GET",
  "headers": {
    "Authorization": "Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    "cache-control": "no-cache",
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

import requests

url = "http://your_domain_name/api/v1/organizations/1"

payload = ""
headers = {
    'Authorization': "Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    'cache-control': "no-cache",
response = requests.request("GET", url, data=payload, headers=headers)

print(response.text)

Displays a organization information using id attribute.

Required permission:

ticket.agent or admin.organization (can read all organizations)
any (can only read its own user if exists)

Http Request

GET /api/v1/organizations/{id}

Response

Expected Response Code: 200

Create

{
    "id": 3,
    "name": "Test Org",
    "shared": true,
    "domain": "",
    "domain_assignment": false,
    "active": true,
    "note": "some note test",
    "updated_by_id": 5,
    "created_by_id": 5,
    "created_at": "2019-03-15T01:10:14.474Z",
    "updated_at": "2019-03-15T01:10:14.474Z",
    "member_ids": []
}

curl --request POST \
  --url http://your_domain_name/api/v1/organizations \
  --header 'Authorization: Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0' \
  --header 'Content-Type: application/json' \
  --header 'cache-control: no-cache' \
  --data '{\r\n "name": "Test Org",\r\n "shared": true,\r\n "active": true,\r\n "note": "some note test"\r\n}'

<?php

$request = new HttpRequest();
$request->setUrl('http://your_domain_name/api/v1/organizations');
$request->setMethod(HTTP_METH_POST);

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'Authorization' => 'Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0',
  'Content-Type' => 'application/json'
));

$request->setBody('{
 "name": "Test Org",
 "shared": true,
 "active": true,
 "note": "some note test"
}');

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://your_domain_name/api/v1/organizations",
  "method": "POST",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    "cache-control": "no-cache",
  },
  "processData": false,
  "data": "{\r\n \"name\": \"Test Org\",\r\n \"shared\": true,\r\n \"active\": true,\r\n \"note\": \"some note test\"\r\n}"
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\r\n \"name\": \"Test Org\",\r\n \"shared\": true,\r\n \"active\": true,\r\n \"note\": \"some note test\"\r\n}");
Request request = new Request.Builder()
  .url("http://your_domain_name/api/v1/organizations")
  .post(body)
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

require 'uri'
require 'net/http'

url = URI("http://your_domain_name/api/v1/organizations")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request["Authorization"] = 'Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0'
request["cache-control"] = 'no-cache'
request.body = "{\r\n \"name\": \"Test Org\",\r\n \"shared\": true,\r\n \"active\": true,\r\n \"note\": \"some note test\"\r\n}"

response = http.request(request)
puts response.read_body

import requests

url = "http://your_domain_name/api/v1/organizations"

payload = "{\r\n \"name\": \"Test Org\",\r\n \"shared\": true,\r\n \"active\": true,\r\n \"note\": \"some note test\"\r\n}"
headers = {
    'Content-Type': "application/json",
    'Authorization': "Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    'cache-control': "no-cache",
    }

response = requests.request("POST", url, data=payload, headers=headers)

print(response.text)

Creates a new organization.

Required permission:

admin.organization

Http Request:

POST /api/v1/organizations

Response

Expected Response Code: 200

Update

{
 "id": 123,
 "name": "Org 1",
 "shared": true,
 "active": true,
 "note": "some note"
}

curl --request PUT \
  --url http://your_domain_name/api/v1/organizations/1 \
  --header 'Authorization: Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0' \
  --header 'Content-Type: application/json' \
  --header 'cache-control: no-cache' \
  --data '{\r\n "id": 123,\r\n "name": "Org 1",\r\n "shared": true,\r\n "active": true,\r\n "note": "some note"\r\n}'

<?php

$request = new HttpRequest();
$request->setUrl('http://your_domain_name/api/v1/organizations/1');
$request->setMethod(HTTP_METH_PUT);

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'Authorization' => 'Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0',
  'Content-Type' => 'application/json'
));

$request->setBody('{
 "id": 123,
 "name": "Org 1",
 "shared": true,
 "active": true,
 "note": "some note"
}');

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\r\n \"id\": 123,\r\n \"name\": \"Org 1\",\r\n \"shared\": true,\r\n \"active\": true,\r\n \"note\": \"some note\"\r\n}");
Request request = new Request.Builder()
  .url("http://your_domain_name/api/v1/organizations/1")
  .put(body)
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

require 'uri'
require 'net/http'

url = URI("http://your_domain_name/api/v1/organizations/1")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request["Authorization"] = 'Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0'
request["cache-control"] = 'no-cache'
request.body = "{\r\n \"id\": 123,\r\n \"name\": \"Org 1\",\r\n \"shared\": true,\r\n \"active\": true,\r\n \"note\": \"some note\"\r\n}"

response = http.request(request)
puts response.read_body

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://your_domain_name/api/v1/organizations/1",
  "method": "PUT",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    "cache-control": "no-cache",
  },
  "processData": false,
  "data": "{\r\n \"id\": 123,\r\n \"name\": \"Org 1\",\r\n \"shared\": true,\r\n \"active\": true,\r\n \"note\": \"some note\"\r\n}"
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

import requests

url = "http://your_domain_name/api/v1/organizations/1"

payload = "{\r\n \"id\": 123,\r\n \"name\": \"Org 1\",\r\n \"shared\": true,\r\n \"active\": true,\r\n \"note\": \"some note\"\r\n}"
headers = {
    'Content-Type': "application/json",
    'Authorization': "Basic fghpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    'cache-control': "no-cache",
    }

response = requests.request("PUT", url, data=payload, headers=headers)

print(response.text)

Update the organization by using ID.

Required permission:

admin.organization

Http Request:

PUT /api/v1/organizations/{id}

Response

Expected Response Code: 200

Delete

{}

curl --request DELETE \
  --url http://your_domain_name/api/v1/organizations/3 \
  --header 'Authorization: Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0' \
  --header 'cache-control: no-cache'

<?php

$request = new HttpRequest();
$request->setUrl('http://your_domain_name/api/v1/organizations/3');
$request->setMethod(HTTP_METH_DELETE);

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'Authorization' => 'Basic jklpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://your_domain_name/api/v1/organizations/3",
  "method": "DELETE",
  "headers": {
    "Authorization": "Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    "cache-control": "no-cache",
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("http://your_domain_name/api/v1/organizations/3")
  .delete(null)
  .addHeader("Authorization", "Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

require 'uri'
require 'net/http'

url = URI("http://your_domain_name/api/v1/organizations/3")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0'
request["cache-control"] = 'no-cache'
response = http.request(request)
puts response.read_body

import requests

url = "http://your_domain_name/api/v1/organizations/3"

payload = ""
headers = {
    'Authorization': "Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    'cache-control': "no-cache",
    }

response = requests.request("DELETE", url, data=payload, headers=headers)

print(response.text)

Delete a organization using ID.

Required permission:

admin.organization (only if no references in history tables and tickets exist)

Http Request:

DELETE /api/v1/organization/{id}

Response:

Expected Response Code: 200

Group

List

{
    "id": 1,
    "signature_id": 1,
    "email_address_id": null,
    "name": "Users",
    "assignment_timeout": null,
    "follow_up_possible": "yes",
    "follow_up_assignment": true,
    "active": true,
    "note": "Standard Group/Pool for Tickets.",
    "updated_by_id": 5,
    "created_by_id": 1,
    "created_at": "2019-03-08T19:47:00.914Z",
    "updated_at": "2019-03-12T07:18:47.665Z",
    "user_ids": [
        3,
        6,
        5
    ]
}

curl --request GET \
  --url http://your_domain_name/api/v1/groups \
  --header 'Authorization: Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0' \
  --header 'cache-control: no-cache'

<?php

$request = new HttpRequest();
$request->setUrl('http://your_domain_name/api/v1/groups');
$request->setMethod(HTTP_METH_GET);

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'Authorization' => 'Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("http://your_domain_name/api/v1/groups")
  .get()
  .addHeader("Authorization", "Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

require 'uri'
require 'net/http'

url = URI("http://your_domain_name/api/v1/groups")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0'
request["cache-control"] = 'no-cache'
response = http.request(request)
puts response.read_body

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://your_domain_name/api/v1/groups",
  "method": "GET",
  "headers": {
    "Authorization": "Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    "cache-control": "no-cache",
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

import requests

url = "http://your_domain_name/api/v1/groups"

payload = ""
headers = {
    'Authorization': "Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    'cache-control': "no-cache",
    }

response = requests.request("GET", url, data=payload, headers=headers)

print(response.text)

Get a list of group.

Required permission:

admin.group (can read all groups)

Http Request:

GET /api/v1/groups

Response

Expected Response Code: 200

Show

{
    "id": 1,
    "signature_id": 1,
    "email_address_id": null,
    "name": "Users",
    "assignment_timeout": null,
    "follow_up_possible": "yes",
    "follow_up_assignment": true,
    "active": true,
    "note": "Standard Group/Pool for Tickets.",
    "updated_by_id": 5,
    "created_by_id": 1,
    "created_at": "2019-03-08T19:47:00.914Z",
    "updated_at": "2019-03-12T07:18:47.665Z",
    "user_ids": [
        3,
        6,
        5
    ]
}

curl --request GET \
  --url http://your_domain_name/api/v1/groups/1 \
  --header 'Authorization: Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0' \
  --header 'cache-control: no-cache'

<?php

$request = new HttpRequest();
$request->setUrl('http://your_domain_name/api/v1/groups/1');
$request->setMethod(HTTP_METH_GET);

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'Authorization' => 'Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("http://your_domain_name/api/v1/groups/1")
  .get()
  .addHeader("Authorization", "Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

require 'uri'
require 'net/http'

url = URI("http://your_domain_name/api/v1/groups/1")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic jklpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0'
request["cache-control"] = 'no-cache'
response = http.request(request)
puts response.read_body

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://your_domain_name/api/v1/groups/1",
  "method": "GET",
  "headers": {
    "Authorization": "Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    "cache-control": "no-cache",
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

import requests

url = "http://your_domain_name/api/v1/groups/1"

payload = ""
headers = {
    'Authorization': "Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    'cache-control': "no-cache",
    }

response = requests.request("GET", url, data=payload, headers=headers)

print(response.text)

Displays a group information using id attribute.

Required permission:

admin.group (can read all groups)

Http Request

GET /api/v1/groups/{id}

Response

Expected Response Code: 200

Create

{
 "name": "Group 1",
 "signature_id": 1,
 "email_address_id": null,
 "assignment_timeout": null,
 "follow_up_possible": "yes",
 "follow_up_assignment": true,
 "active": true,
 "note": "Standard Group/Pool for Tickets."
}

curl --request POST \
  --url http://your_domain_name/api/v1/groups \
  --header 'Authorization: Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0' \
  --header 'Content-Type: application/json' \
  --header 'cache-control: no-cache' \
  --data '{\r\n "name": "Group 1",\r\n "signature_id": 1,\r\n "email_address_id": null,\r\n "assignment_timeout": null,\r\n "follow_up_possible": "yes",\r\n "follow_up_assignment": true,\r\n "active": true,\r\n "note": "Standard Group/Pool for Tickets."\r\n}'

<?php

$request = new HttpRequest();
$request->setUrl('http://your_domain_name/api/v1/groups');
$request->setMethod(HTTP_METH_POST);

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'Authorization' => 'Basic jklpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0',
  'Content-Type' => 'application/json'
));

$request->setBody('{
 "name": "Group 1",
 "signature_id": 1,
 "email_address_id": null,
 "assignment_timeout": null,
 "follow_up_possible": "yes",
 "follow_up_assignment": true,
 "active": true,
 "note": "Standard Group/Pool for Tickets."
}');

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\r\n \"name\": \"Group 1\",\r\n \"signature_id\": 1,\r\n \"email_address_id\": null,\r\n \"assignment_timeout\": null,\r\n \"follow_up_possible\": \"yes\",\r\n \"follow_up_assignment\": true,\r\n \"active\": true,\r\n \"note\": \"Standard Group/Pool for Tickets.\"\r\n}");
Request request = new Request.Builder()
  .url("http://your_domain_name/api/v1/groups")
  .post(body)
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

require 'uri'
require 'net/http'

url = URI("http://your_domain_name/api/v1/groups")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request["Authorization"] = 'Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0'
request["cache-control"] = 'no-cache'
request.body = "{\r\n \"name\": \"Group 1\",\r\n \"signature_id\": 1,\r\n \"email_address_id\": null,\r\n \"assignment_timeout\": null,\r\n \"follow_up_possible\": \"yes\",\r\n \"follow_up_assignment\": true,\r\n \"active\": true,\r\n \"note\": \"Standard Group/Pool for Tickets.\"\r\n}"

response = http.request(request)
puts response.read_body

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://your_domain_name/api/v1/groups",
  "method": "POST",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    "cache-control": "no-cache",
  },
  "processData": false,
  "data": "{\r\n \"name\": \"Group 1\",\r\n \"signature_id\": 1,\r\n \"email_address_id\": null,\r\n \"assignment_timeout\": null,\r\n \"follow_up_possible\": \"yes\",\r\n \"follow_up_assignment\": true,\r\n \"active\": true,\r\n \"note\": \"Standard Group/Pool for Tickets.\"\r\n}"
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

import requests

url = "http://your_domain_name/api/v1/groups"

payload = "{\r\n \"name\": \"Group 1\",\r\n \"signature_id\": 1,\r\n \"email_address_id\": null,\r\n \"assignment_timeout\": null,\r\n \"follow_up_possible\": \"yes\",\r\n \"follow_up_assignment\": true,\r\n \"active\": true,\r\n \"note\": \"Standard Group/Pool for Tickets.\"\r\n}"
headers = {
    'Content-Type': "application/json",
    'Authorization': "Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    'cache-control': "no-cache",
    }

response = requests.request("POST", url, data=payload, headers=headers)

print(response.text)

Create a new group.

Required permission:

admin.group

Http Request:

POST /api/v1/groups

Response

Expected Response Code: 200

Update

{
    "id": 1,
    "name": "Users",
    "signature_id": 1,
    "email_address_id": null,
    "assignment_timeout": null,
    "follow_up_possible": "yes",
    "follow_up_assignment": true,
    "active": true,
    "note": "Standard Group/Pool for Tickets.",
    "updated_by_id": 5,
    "created_by_id": 1,
    "created_at": "2019-03-08T19:47:00.914Z",
    "updated_at": "2019-03-12T07:18:47.665Z",
    "user_ids": [
        3,
        6,
        5
    ]
}

curl --request PUT \
  --url http://your_domain_name/api/v1/groups/1 \
  --header 'Authorization: Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0' \
  --header 'cache-control: no-cache'

<?php

$request = new HttpRequest();
$request->setUrl('http://your_domain_name/api/v1/groups/1');
$request->setMethod(HTTP_METH_PUT);

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'Authorization' => 'Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("http://your_domain_name/api/v1/groups/1")
  .put(null)
  .addHeader("Authorization", "Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

require 'uri'
require 'net/http'

url = URI("http://your_domain_name/api/v1/groups/1")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0'
request["cache-control"] = 'no-cache'
response = http.request(request)
puts response.read_body

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://your_domain_name/api/v1/groups/1",
  "method": "PUT",
  "headers": {
    "Authorization": "Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    "cache-control": "no-cache",
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

import requests

url = "http://your_domain_name/api/v1/groups/1"

payload = ""
headers = {
    'Authorization': "Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    'cache-control': "no-cache",
    }

response = requests.request("PUT", url, data=payload, headers=headers)

print(response.text)

Update any group.

Required permission:

admin.group

Http Request

PUT /api/v1/groups/{id}

Response

Expected Response Code: 200

Delete

{}

curl --request DELETE \
  --url http://your_domain_name/api/v1/groups/4 \
  --header 'Authorization: Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0' \
  --header 'cache-control: no-cache'

<?php

$request = new HttpRequest();
$request->setUrl('http://your_domain_name/api/v1/groups/4');
$request->setMethod(HTTP_METH_DELETE);

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'Authorization' => 'Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://your_domain_name/api/v1/groups/4",
  "method": "DELETE",
  "headers": {
    "Authorization": "Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    "cache-control": "no-cache",
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("http://your_domain_name/api/v1/groups/4")
  .delete(null)
  .addHeader("Authorization", "Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

require 'uri'
require 'net/http'

url = URI("your_domain_name/api/v1/groups/4")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0'
request["cache-control"] = 'no-cache'

response = http.request(request)
puts response.read_body

import requests

url = "your_domain_name/api/v1/groups/4"

payload = ""
headers = {
    'Authorization': "Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    'cache-control': "no-cache",
    }

response = requests.request("DELETE", url, data=payload, headers=headers)

print(response.text)

Delete any group.

Required permission:

admin.group (only if no references in history tables and tickets exist)

Http Request:

DELETE /api/v1/groups/{id}

Response

Expected Response Code: 200

Online Notification

List

Returns a list of online notification.


    {

        "id": 4,
        "o_id": 2,
        "object_lookup_id": 2,
        "type_lookup_id": 3,
        "user_id": 5,
        "seen": false,
        "updated_by_id": 6,
        "created_by_id": 6,
        "created_at": "2019-03-12T13:05:44.946Z",
        "updated_at": "2019-03-12T13:05:44.946Z"
    }
]

curl --request GET \
  --url http://your_domain_name/api/v1/online_notifications \
  --header 'Authorization: Basic jklpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0' \
  --header 'cache-control: no-cache'

<?php

$request = new HttpRequest();
$request->setUrl('http://your_domain_name/api/v1/online_notifications');
$request->setMethod(HTTP_METH_GET);

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'Authorization' => 'Basic jklpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("http://your_domain_name/api/v1/online_notifications")
  .get()
  .addHeader("Authorization", "Basic jklpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

require 'uri'
require 'net/http'

url = URI("http://your_domain_name/api/v1/online_notifications")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic jklpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0'
request["cache-control"] = 'no-cache'
response = http.request(request)
puts response.read_body

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://your_domain_name/api/v1/online_notifications",
  "method": "GET",
  "headers": {
    "Authorization": "Basic jklpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    "cache-control": "no-cache",
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

import requests

url = "http://your_domain_name/api/v1/online_notifications"

payload = ""
headers = {
    'Authorization': "Basic jklpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    'cache-control': "no-cache",
    }

response = requests.request("GET", url, data=payload, headers=headers)

print(response.text)

Required permission:

authenticated user (content of notitifcations depends on user permissions)

Http Request:

GET /api/v1/online_notifications

Response

Expected Response Code: 200

Show

{
    "id": 4,
    "o_id": 2,
    "object_lookup_id": 2,
    "type_lookup_id": 3,
    "user_id": 5,
    "seen": false,
    "updated_by_id": 6,
    "created_by_id": 6,
    "created_at": "2019-03-12T13:05:44.946Z",
    "updated_at": "2019-03-12T13:05:44.946Z"
}

curl --request GET \
  --url http://your_domain_name/api/v1/online_notifications/4 \
  --header 'Authorization: Basic jklpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0' \
  --header 'cache-control: no-cache'

<?php

$request = new HttpRequest();
$request->setUrl('http://your_domain_name/api/v1/online_notifications/4');
$request->setMethod(HTTP_METH_GET);

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'Authorization' => 'Basic jklpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("http://your_domain_name/api/v1/online_notifications/4")
  .get()
  .addHeader("Authorization", "Basic jklpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

require 'uri'
require 'net/http'

url = URI("http://your_domain_name/api/v1/online_notifications/4")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0'
request["cache-control"] = 'no-cache'
response = http.request(request)
puts response.read_body

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://your_domain_name/api/v1/online_notifications/4",
  "method": "GET",
  "headers": {
    "Authorization": "Basic jklpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    "cache-control": "no-cache",
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

import requests

url = "http://your_domain_name/api/v1/online_notifications/4"

payload = ""
headers = {
    'Authorization': "Basic jklpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    'cache-control': "no-cache",
    }

response = requests.request("GET", url, data=payload, headers=headers)

print(response.text)

Displays an online notification using id attribute.

Required permission:

authenticated user (content of notifications depends on user permissions)

Htttp Request:

GET /api/v1/online_notifications/{id}

Response

Expected Response Code: 200

Update

{
    "id": 4,
    "seen": true,
    "o_id": 2,
    "object_lookup_id": 2,
    "type_lookup_id": 3,
    "user_id": 5,
    "updated_by_id": 5,
    "created_by_id": 6,
    "created_at": "2019-03-12T13:05:44.946Z",
    "updated_at": "2019-03-14T04:37:58.619Z"
}

curl --request PUT \
  --url http://your_domain_name/api/v1/online_notifications/4 \
  --header 'Authorization: Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0' \
  --header 'Content-Type: application/json' \
  --header 'cache-control: no-cache' \
  --data '{\r\n  "seen": true\r\n}'

<?php

$request = new HttpRequest();
$request->setUrl('http://your_domain_name/api/v1/online_notifications/4');
$request->setMethod(HTTP_METH_PUT);

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'Authorization' => 'Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0',
  'Content-Type' => 'application/json'
));

$request->setBody('{
  "seen": true
}');

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\r\n  \"seen\": true\r\n}");
Request request = new Request.Builder()
  .url("http://your_domain_name/api/v1/online_notifications/4")
  .put(body)
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

require 'uri'
require 'net/http'

url = URI("http://your_domain_name/api/v1/online_notifications/4")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request["Authorization"] = 'Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0'
request["cache-control"] = 'no-cache'
request.body = "{\r\n  \"seen\": true\r\n}"

response = http.request(request)
puts response.read_body

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://your_domain_name/api/v1/online_notifications/4",
  "method": "PUT",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    "cache-control": "no-cache",
  },
  "processData": false,
  "data": "{\r\n  \"seen\": true\r\n}"
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

import requests

url = "http://your_domain_name/api/v1/online_notifications/4"

payload = "{\r\n  \"seen\": true\r\n}"
headers = {
    'Content-Type': "application/json",
    'Authorization': "Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    'cache-control': "no-cache",
    }

response = requests.request("PUT", url, data=payload, headers=headers)

print(response.text)

Update any online notification.

Required permission:

admin.object

Http Request

PUT /api/v1/online_notifications/{id}

Response

Expected Response Code: 200

Delete

{}

curl --request DELETE \
  --url http://your_domain_name/api/v1/online_notifications/4 \
  --header 'Authorization: Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0' \
  --header 'cache-control: no-cache'

<?php

$request = new HttpRequest();
$request->setUrl('http://your_domain_name/api/v1/online_notifications/4');
$request->setMethod(HTTP_METH_DELETE);

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'Authorization' => 'Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("http://your_domain_name/api/v1/online_notifications/4")
  .delete(null)
  .addHeader("Authorization", "Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

require 'uri'
require 'net/http'

url = URI("http://your_domain_name/api/v1/online_notifications/4")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0'
request["cache-control"] = 'no-cache'
response = http.request(request)
puts response.read_body

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://your_domain_name/api/v1/online_notifications/4",
  "method": "DELETE",
  "headers": {
    "Authorization": "Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    "cache-control": "no-cache",
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

import requests

url = "http://your_domain_name/api/v1/online_notifications/4"

payload = ""
headers = {
    'Authorization': "Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    'cache-control': "no-cache",
    }

response = requests.request("DELETE", url, data=payload, headers=headers)

print(response.text)

Delete a online notification using ID.

Required permission:

authenticated user (content of notifications depends on user permissions)

Http Request:

DELETE /api/v1/online_notifications/{id}

Response

Expected Response Code: 200

Mark all as read

{}

curl --request POST \
  --url http://your_domain_name/api/v1/online_notifications/mark_all_as_read \
  --header 'Authorization: Basic jkhpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0' \
  --header 'cache-control: no-cache'

<?php

$request = new HttpRequest();
$request->setUrl('http://your_domain_name/api/v1/online_notifications/mark_all_as_read');
$request->setMethod(HTTP_METH_POST);

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'Authorization' => 'Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("http://your_domain_name/api/v1/online_notifications/mark_all_as_read")
  .post(null)
  .addHeader("Authorization", "Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

require 'uri'
require 'net/http'

url = URI("http://your_domain_name/api/v1/online_notifications/mark_all_as_read")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0'
request["cache-control"] = 'no-cache'
response = http.request(request)
puts response.read_body

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://your_domain_name/api/v1/online_notifications/mark_all_as_read",
  "method": "POST",
  "headers": {
    "Authorization": "Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    "cache-control": "no-cache",
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

import requests

url = "http://your_domain_name/api/v1/online_notifications/mark_all_as_read"

payload = ""
headers = {
    'Authorization': "Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    'cache-control': "no-cache",
    }

response = requests.request("POST", url, data=payload, headers=headers)

print(response.text)

Mark all online notification as read.

Required permission:

authenticated user (content of notifications depends on user permissions)

Http Request:

POST /api/v1/online_notifications/mark_all_as_read

Response

Expected Response Code: 200

Object

List

[
    {
        "id": 2,
        "name": "customer_id",
        "display": "Customer",
        "data_type": "user_autocompletion",
        "data_option": {
            "relation": "User",
            "autocapitalize": false,
            "multiple": false,
            "guess": true,
            "null": false,
            "limit": 200,
            "placeholder": "Enter Person or Organization/Company",
            "minLengt": 2,
            "translate": false,
            "permission": [
                "ticket.agent"
            ]
        },
        "data_option_new": {},
        "editable": false,
        "active": true,
        "screens": {
            "create_top": {
                "-all-": {
                    "null": false
                }
            },....
}

curl --request GET \
  --url http://your_domain_name/api/v1/object_manager_attributes \
  --header 'Authorization: Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0' \
  --header 'cache-control: no-cache'

<?php

$request = new HttpRequest();
$request->setUrl('http://your_domain_name/api/v1/object_manager_attributes');
$request->setMethod(HTTP_METH_GET);

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'Authorization' => 'Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("http://your_domain_name/api/v1/object_manager_attributes")
  .get()
  .addHeader("Authorization", "Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

require 'uri'
require 'net/http'

url = URI("http://your_domain_name/api/v1/object_manager_attributes")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0'
request["cache-control"] = 'no-cache'
response = http.request(request)
puts response.read_body

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://your_domain_name/api/v1/object_manager_attributes",
  "method": "GET",
  "headers": {
    "Authorization": "Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    "cache-control": "no-cache",
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

import requests

url = "http://your_domain_name/api/v1/object_manager_attributes"

payload = ""
headers = {
    'Authorization': "Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    'cache-control': "no-cache",
    }

response = requests.request("GET", url, data=payload, headers=headers)

print(response.text)

Get a list of object.

Required permission

admin (access to admin interface)

Http Request

GET /api/v1/object_manager_attributes

Response

Expected Response Code: 200

Show

[
    {
        "id": 2,
        "name": "customer_id",
        "display": "Customer",
        "data_type": "user_autocompletion",
        "data_option": {
            "relation": "User",
            "autocapitalize": false,
            "multiple": false,
            "guess": true,
            "null": false,
            "limit": 200,
            "placeholder": "Enter Person or Organization/Company",
            "minLengt": 2,
            "translate": false,
            "permission": [
                "ticket.agent"
            ]
        },
        "data_option_new": {},
        "editable": false,
        "active": true,
        "screens": {
            "create_top": {
                "-all-": {
                    "null": false
                }
            },....
}

curl --request GET \
  --url http://your_domain_name/api/v1/object_manager_attributes/ \
  --header 'Authorization: Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0' \
  --header 'cache-control: no-cache'

<?php

$request = new HttpRequest();
$request->setUrl('http://your_domain_name/api/v1/object_manager_attributes/');
$request->setMethod(HTTP_METH_GET);

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'Authorization' => 'Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("http://your_domain_name/api/v1/object_manager_attributes/")
  .get()
  .addHeader("Authorization", "Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

require 'uri'
require 'net/http'

url = URI("http://your_domain_name/api/v1/object_manager_attributes/")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0'
request["cache-control"] = 'no-cache'
response = http.request(request)
puts response.read_body

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://your_domain_name/api/v1/object_manager_attributes/",
  "method": "GET",
  "headers": {
    "Authorization": "Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    "cache-control": "no-cache",
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

import requests

url = "http://your_domain_name/api/v1/object_manager_attributes/"

payload = ""
headers = {
    'Authorization': "Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    'cache-control': "no-cache",
    }

response = requests.request("GET", url, data=payload, headers=headers)

print(response.text)

Displays an Object information using id attribute.

Required permission:

admin (access to admin interface)

Http Request:

GET /api/v1/object_manager_attributes/:id

Response

Expected Response Code: 200

Create

{
    "id": 49,
    "object_lookup_id": 2,
    "name": "product",
    "display": "Produkt",
    "data_type": "select",
    "data_option": {
        "options": {
            "wert1": "anzeige1",
            "wert2": "anzeige12"
        },
        "default": "",
        "null": true,
        "relation": "",
        "nulloption": true,
        "maxlength": 255
    },
    "data_option_new": {},
    "editable": true,
    "active": true,
    "screens": {},
    "to_create": true,
    "to_migrate": true,
    "to_delete": false,
    "to_config": false,
    "position": 1550,
    "created_by_id": 5,
    "updated_by_id": 5,
    "created_at": "2019-03-15T12:38:35.444Z",
    "updated_at": "2019-03-15T12:38:35.444Z"
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\r\n   \"name\":\"product\",\r\n   \"object\":\"Ticket\",\r\n   \"display\":\"Produkt\",\r\n   \"active\":true,\r\n   \"data_type\":\"select\",\r\n   \"data_option\":{\r\n      \"options\":{\r\n         \"wert1\":\"anzeige1\",\r\n         \"wert2\":\"anzeige12\"\r\n      }\r\n   }\r\n}");
Request request = new Request.Builder()
  .url("http://your_domain_name/api/v1/object_manager_attributes")
  .post(body)
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Basic jhjf430oaQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://your_domain_name/api/v1/object_manager_attributes",
  "method": "POST",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Basic sbvdf367qGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    "cache-control": "no-cache",
  },
  "processData": false,
  "data": "{\r\n   \"name\":\"product\",\r\n   \"object\":\"Ticket\",\r\n   \"display\":\"Produkt\",\r\n   \"active\":true,\r\n   \"data_type\":\"select\",\r\n   \"data_option\":{\r\n      \"options\":{\r\n         \"wert1\":\"anzeige1\",\r\n         \"wert2\":\"anzeige12\"\r\n      }\r\n   }\r\n}"
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

<?php

$request = new HttpRequest();
$request->setUrl('http://your_domain_name/api/v1/object_manager_attributes');
$request->setMethod(HTTP_METH_POST);

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'Authorization' => 'Basic jgweumw4fGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0',
  'Content-Type' => 'application/json'
));

$request->setBody('{
   "name":"product",
   "object":"Ticket",
   "display":"Produkt",
   "active":true,
   "data_type":"select",
   "data_option":{
      "options":{
         "wert1":"anzeige1",
         "wert2":"anzeige12"
      }
   }
}');

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

import requests

url = "http://your_domain_name/api/v1/object_manager_attributes"

payload = "{\r\n   \"name\":\"product\",\r\n   \"object\":\"Ticket\",\r\n   \"display\":\"Produkt\",\r\n   \"active\":true,\r\n   \"data_type\":\"select\",\r\n   \"data_option\":{\r\n      \"options\":{\r\n         \"wert1\":\"anzeige1\",\r\n         \"wert2\":\"anzeige12\"\r\n      }\r\n   }\r\n}"
headers = {
    'Content-Type': "application/json",
    'Authorization': "Basic jhbsiue2QGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    'cache-control': "no-cache",
    }

response = requests.request("POST", url, data=payload, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

url = URI("http://your_domain_name/api/v1/object_manager_attributes")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request["Authorization"] = 'Basic hghqwjv2QGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0'
request["cache-control"] = 'no-cache'
request.body = "{\r\n   \"name\":\"product\",\r\n   \"object\":\"Ticket\",\r\n   \"display\":\"Produkt\",\r\n   \"active\":true,\r\n   \"data_type\":\"select\",\r\n   \"data_option\":{\r\n      \"options\":{\r\n         \"wert1\":\"anzeige1\",\r\n         \"wert2\":\"anzeige12\"\r\n      }\r\n   }\r\n}"

response = http.request(request)
puts response.read_body

curl --request POST \
  --url http://your_domain_name/api/v1/object_manager_attributes \
  --header 'Authorization: Basic jkhbwe34QGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0' \
  --header 'Content-Type: application/json' \
  --header 'cache-control: no-cache' \
  --data '{\r\n   "name":"product",\r\n   "object":"Ticket",\r\n   "display":"Produkt",\r\n   "active":true,\r\n   "data_type":"select",\r\n   "data_option":{\r\n      "options":{\r\n         "wert1":"anzeige1",\r\n         "wert2":"anzeige12"\r\n      }\r\n   }\r\n}'

Creates a new Object.

Required permission

admin (access to admin interface)

Http Request

POST /api/v1/object_manager_attributes

Response

Expected Response Code: 200

Update

{
   "id":49,
   "name":"anrede",
   "display":"Anrede",
   "data_type":"select",
   "data_option":{
      "options":{
         "Mr":"Mr",
         "Ms":"Ms",
         "Company":"Company"
      },
      "default":"Mr",
      "null":true,
      "maxlength":255,
      "nulloption":true
   }
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n\t    \"name\": \"product1234\"\n}");
Request request = new Request.Builder()
  .url("http://your_domain_name/api/v1/object_manager_attributes/49")
  .put(body)
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Basic asdmnjj31QGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://your_domain_name/api/v1/object_manager_attributes/49",
  "method": "PUT",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Basic jbvgew35QGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    "cache-control": "no-cache",
  },
  "processData": false,
  "data": "{\n\t    \"name\": \"product1234\"\n}"
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

<?php

$request = new HttpRequest();
$request->setUrl('http://your_domain_name/api/v1/object_manager_attributes/49');
$request->setMethod(HTTP_METH_PUT);

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'Authorization' => 'Basic amdbyue19RhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0',
  'Content-Type' => 'application/json'
));

$request->setBody('{
        "name": "product1234"
}');

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

import requests

url = "http://your_domain_name/api/v1/object_manager_attributes/49"

payload = "{\n\t    \"name\": \"product1234\"\n}"
headers = {
    'Content-Type': "application/json",
    'Authorization': "Basic maoure10QGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    'cache-control': "no-cache",
    }

response = requests.request("PUT", url, data=payload, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

url = URI("http://your_domain_name/api/v1/object_manager_attributes/49")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request["Authorization"] = 'Basic amsjdyye1QGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0'
request["cache-control"] = 'no-cache'
request.body = "{\n\t    \"name\": \"product1234\"\n}"

response = http.request(request)
puts response.read_body

curl --request PUT \
  --url http://your_domain_name/api/v1/object_manager_attributes/49 \
  --header 'Authorization: Basic amwer2o1QGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0' \
  --header 'Content-Type: application/json' \
  --header 'cache-control: no-cache' \
  --data '{\n       "name": "product1234"\n}'

Updates a new Object.

Required permission

admin (access to admin interface)

Http Request

PUT /api/v1/object_manager_attributes/:id

Response

Expected Response Code: 200

Execute Database Migrations

{}

curl --request POST \
  --url http://your_domain_name/api/v1/object_manager_attributes_execute_migrations \
  --header 'Authorization: Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0' \
  --header 'cache-control: no-cache'

<?php

$request = new HttpRequest();
$request->setUrl('http://your_domain_name/api/v1/object_manager_attributes_execute_migrations');
$request->setMethod(HTTP_METH_POST);

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'Authorization' => 'Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("http://your_domain_name/api/v1/object_manager_attributes_execute_migrations")
  .post(null)
  .addHeader("Authorization", "Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0")
  .addHeader("cache-control", "no-cache")
  .build();
Response response = client.newCall(request).execute();

require 'uri'
require 'net/http'

url = URI("http://your_domain_name/api/v1/object_manager_attributes_execute_migrations")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic ghjpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0'
request["cache-control"] = 'no-cache'
response = http.request(request)
puts response.read_body

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://your_domain_name/api/v1/object_manager_attributes_execute_migrations",
  "method": "POST",
  "headers": {
    "Authorization": "Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    "cache-control": "no-cache",
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

import requests

url = "http://your_domain_name/api/v1/object_manager_attributes_execute_migrations"

payload = ""
headers = {
    'Authorization': "Basic hjkpa2hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    'cache-control': "no-cache",
    }

response = requests.request("POST", url, data=payload, headers=headers)

print(response.text)

Required permission

admin (access to admin interface)

Http Request

POST /api/v1/object_manager_attributes_execute_migrations

Response

Expected Response Code: 200

User Access Token

List

{
    "tokens": [],
    "permissions": [
        {
            "id": 1,
            "name": "admin",
            "note": "Admin Interface",
            "preferences": {},
            "active": true,
            "created_at": "2019-03-08T19:47:00.068Z",
            "updated_at": "2019-03-08T19:47:00.068Z"
        },
        {
            "id": 29,
            "name": "admin.api",
            "note": "Manage %s",
            "preferences": {
                "translations": [
                    "API"
                ]
            },
            "active": true,
            "created_at": "2019-03-08T19:47:00.425Z",
            "updated_at": "2019-03-08T19:47:00.425Z"
        },
        {
            "id": 23,
            "name": "admin.branding",
            "note": "Manage %s",
            "preferences": {
                "translations": [
                    "Branding"
                ]
            },
            "active": true,
            "created_at": "2019-03-08T19:47:00.346Z",
            "updated_at": "2019-03-08T19:47:00.346Z"
        },
]
}

kHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("http://your_domain_name/api/v1/user_access_token")
  .get()
  .addHeader("Authorization", "Basic jhdf3hhQGRhdGFhZWdpcpujb206U2hpa2hhX0AxMjM0")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://your_domain_name/api/v1/user_access_token",
  "method": "GET",
  "headers": {
    "Authorization": "Basic gsdf3j77QGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    "cache-control": "no-cache",
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

<?php

$request = new HttpRequest();
$request->setUrl('http://your_domain_name/api/v1/user_access_token');
$request->setMethod(HTTP_METH_GET);

$request->setHeaders(array(

  'cache-control' => 'no-cache',
  'Authorization' => 'Basic ggvds2llQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

import requests

url = "http://your_domain_name/api/v1/user_access_token"

payload = ""
headers = {
    'Authorization': "Basic hsdv32hhQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    'cache-control': "no-cache",
    }

response = requests.request("GET", url, data=payload, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

url = URI("http://your_domain_name/api/v1/user_access_token")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic gsdv3hhQGRhdGFhZWdpcy5jb90872hpa2hhX0AxMjM0'
request["cache-control"] = 'no-cache'

response = http.request(request)
puts response.read_body

curl --request GET \
  --url http://your_domain_name/api/v1/user_access_token \
  --header 'Authorization: Basic jsdf32hhQGRhdGFhZWdcopu3jb206U2hpa2hhX0AxMjM0' \

  --header 'cache-control: no-cache'

List the all user access tokens.

Required permission

user_preferences.access_token

HTTP Request

GET /api/v1/user_access_token

Response

Expected Response Code: 200

Create

{
    "name": "oorvNShiOHrxyYPDa7L7c4PvDj91cDl0rsy8dlcUpK9OMp1cygGgeq_06Ve742RJ"
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\r\n  \"label\":\"some test\",\r\n  \"permission\":[\"cti.agent\",\"ticket.agent\"],\r\n  \"expires_at\":null\r\n}\r\n");
Request request = new Request.Builder()
  .url("http://your_domain_name/api/v1/user_access_token")
  .post(body)
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Basic hgdsv2hhQGRhdGFhZWdpcy5ji206U2hpa2hhX0AxMjM0")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://your_domain_name/api/v1/user_access_token",
  "method": "POST",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Basic sdvvsdg4QGRhdGFhZWdbcy5jb206U2hpa2hhX0AxMjM0",
    "cache-control": "no-cache",
    "Postman-Token": "0ee958d4-8fac-4eeb-88d3-ad07cb7fd04f"
  },
  "processData": false,
  "data": "{\r\n  \"label\":\"some test\",\r\n  \"permission\":[\"cti.agent\",\"ticket.agent\"],\r\n  \"expires_at\":null\r\n}\r\n"
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

<?php

$request = new HttpRequest();
$request->setUrl('http://your_domain_name/api/v1/user_access_token');
$request->setMethod(HTTP_METH_POST);

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'Authorization' => 'Basic jdsbjh42QGRhdGFhZWdpcy5j8s06U2hpa2hhX0AxMjM0',
  'Content-Type' => 'application/json'
));

$request->setBody('{
  "label":"some test",
  "permission":["cti.agent","ticket.agent"],
  "expires_at":null
}
');

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

import requests

url = "http://your_domain_name/api/v1/user_access_token"

payload = "{\r\n  \"label\":\"some test\",\r\n  \"permission\":[\"cti.agent\",\"ticket.agent\"],\r\n  \"expires_at\":null\r\n}\r\n"
headers = {
    'Content-Type': "application/json",
    'Authorization': "Basic hsdf3q9QGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    'cache-control': "no-cache",
    }

response = requests.request("POST", url, data=payload, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

url = URI("http://your_domain_name/api/v1/user_access_token")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request["Authorization"] = 'Basic sjd4nb0oQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0'
request["cache-control"] = 'no-cache'
request.body = "{\r\n  \"label\":\"some test\",\r\n  \"permission\":[\"cti.agent\",\"ticket.agent\"],\r\n  \"expires_at\":null\r\n}\r\n"

response = http.request(request)
puts response.read_body

curl --request POST \
  --url http://your_domain_name/api/v1/user_access_token \
  --header 'Authorization: Basic fsvh4hbsQGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0' \
  --header 'Content-Type: application/json' \
  --header 'cache-control: no-cache' \
  --data '{\r\n  "label":"some test",\r\n  "permission":["cti.agent","ticket.agent"],\r\n  "expires_at":null\r\n}\r\n'

Creates a User Access Token.

Required permission

user_preferences.access_token

HTTP Request

POST /api/v1/user_access_token

Response

Expected Response Code: 200

Delete

{}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("http://your_domain_name/api/v1/user_access_token/1")
  .delete(null)
  .addHeader("Authorization", "Basic jhdshj45QGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0")
  .addHeader("cache-control", "no-cache")
  .build();

Response response = client.newCall(request).execute();

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://your_domain_name/api/v1/user_access_token/1",
  "method": "DELETE",
  "headers": {
    "Authorization": "Basic hgfw4bh2QGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    "cache-control": "no-cache",
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

<?php

$request = new HttpRequest();
$request->setUrl('http://your_domain_name/api/v1/user_access_token/1');
$request->setMethod(HTTP_METH_DELETE);

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'Authorization' => 'Basic sdki4th9QGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

import requests

url = "http://your_domain_name/api/v1/user_access_token/1"

payload = ""
headers = {
    'Authorization': "Basic cdsttg26QGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0",
    'cache-control': "no-cache",
    }

response = requests.request("DELETE", url, data=payload, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

url = URI("http://your_domain_name/api/v1/user_access_token/1")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Basic jhgfy341QGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0'
request["cache-control"] = 'no-cache'

response = http.request(request)
puts response.read_body

curl --request DELETE \
  --url http://your_domain_name/api/v1/user_access_token/1 \
  --header 'Authorization: Basic shfvhj90QGRhdGFhZWdpcy5jb206U2hpa2hhX0AxMjM0' \
  --header 'cache-control: no-cache'

Deletes a User Access Token.

Required permission

user_preferences.access_token

HTTP Request

PUT /api/v1/user_access_token/:id

Response

Expected Response code: 200