Settings API

Note

The API data from the Settings section can be accessed only by Administrators. The data can be only listed and viewed. To update the settings data, use the appropriate forms from the Settings sections.

Queues

View a Queue

GET /queue/{id}/{permissions}

Parameters

Name	Type	Description
{id}	Integer	Queue ID
{permissions}	Integer	Show the queue permission's list: - 1 - yes - 0 - no

Sample code:

curl -X GET \
  https://acme.sympoq.com/app/desk/api/queue/1/1 \
  -H 'apikey: dWIeGMRlikMIle'

Response:

{
    "id": 1,
    "name": "Inbox",
    "sequence": 10,
    "permissions": [
      {
        "agent": 1,
        "role": "Queue Manager"
      },
      {
        "agent": 2,
        "role": "Agent"
      }
      {
        "agent": 3,
        "role": "Agent"
      }
    ]
}

List all Queues

GET /queues/{permissions}

Name	Type	Description
{permissions}	Integer	Show queue permission's list: - 1 - yes - 0 - no

Sample code:

curl -X GET \
  https://acme.sympoq.com/app/desk/api/queues/0 \
  -H 'apikey: dWIeGMRlikMIle'

Response:

[
    {
        "id": 1,
        "name": "Inbox",
        "sequence": 10
    },
    {
        "id": 2,
        "name": "Support",
        "sequence": 20
    },
    {
        "id": 3,
        "name": "Sales",
        "sequence": 30
    }
]

Topics

View a Topic

GET /topic/{id}

Sample code:

curl -X GET \
  https://acme.sympoq.com/app/desk/api/topic/1 \
  -H 'apikey: dWIeGMRlikMIle'

Response:

{
    "id": 1,
    "name": "General questions",
    "active": true
}

List all Topics

GET /topics

Sample code:

curl -X GET \
  https://acme.sympoq.com/app/desk/api/topics \
  -H 'apikey: dWIeGMRlikMIle' 

Response:

[
    {
        "id": 1,
        "name": "General questions",
        "active": true
    },
    {
        "id": 2,
        "name": "Sales",
        "active": true
    },
    {
        "id": 3,
        "name": "Technical support",
        "active": true
    },
    {
        "id": 4,
        "name": "Billing",
        "active": true
    }
]

Custom fields

List definition

GET /fields/{topic}/{type}

Filters

Name	Type	Description
topic	Integer	The Topic ID
type	Integer	Type of field: - 1 - Submission - 2 - Update

Sample code:

curl -X GET \
  https://acme.sympoq.com/app/desk/api/fields/1/1 \
  -H 'apikey: dWIeGMRlikMIle' 

Response:

[
    {
        "topic": 1,
        "field_name": "text_1",
        "label": "Invoice number",
        "required": true
    },
    {
        "topic": 1,
        "field_name": "text_2",
        "label": "Amount",
        "required": true
    },
    {
        "topic": 1,
        "field_name": "date_1",
        "label": "Due date",
        "required": false
    },
    {
        "topic": 1,
        "field_name": "select_list_1",
        "label": "Payment Method",
        "required": false,
        "values": ["Credit Card", "PayPal", "Wire Transfer"]
    }
]

Canned replies

View a Canned reply

GET /cannedReply/{id}

Sample code:

curl -X GET \
  https://acme.sympoq.com/app/desk/api/cannedReply/1 \
  -H 'apikey: dWIeGMRlikMIle' 

Response:

{
   "id": 1,
   "title": "Billing error",
   "text": "Most customers review their billing statements frequently to ensure that the payments posted to their accounts are correct.\nSometimes, these customers will find errors that your company has made."
}

List all Canned replies

GET /cannedReplies

Sample code:

curl -X GET \
  https://acme.sympoq.com/app/desk/api/cannedReplies \
  -H 'apikey: dWIeGMRlikMIle' 

Response:

[
    {
       "id": 1,
       "title": "Billing error",
       "text": "Most customers review their billing statements frequently to ensure that the payments posted to their accounts are correct.\nSometimes, these customers will find errors that your company has made."
    },
    {
       "id": 2,
       "title": "Apologize",
       "text": "We would like to apologize for any inconvenience. \n\nAlthough it is impossible to prevent errors completely, we will research this issue in order to determine its exact cause and to ensure that it does not happen again."
    }
]

Tags

View a Tag

GET /tag/{id}

Sample code:

curl -X GET \
  https://acme.sympoq.com/app/desk/api/tag/1 \
  -H 'apikey: dWIeGMRlikMIle'

Response:

{
    "id": 1,
    "name": "Service request"
}

List all Tags

GET /tags

Sample code:

curl -X GET \
  https://acme.sympoq.com/app/desk/api/tags \
  -H 'apikey: dWIeGMRlikMIle'

Response:

[
    {
        "id": 1,
        "name": "Service request"
    },
    {
        "id": 2,
        "name": "Help/Assistance"
    },
    {
        "id": 3,
        "name": "Technical incident"
    }
]