Introduction

This API allows you to retrieve details of existing workflow statuses from your CustomerGauge system.

Returns workflow details based on CG-ID.


About this API

Resource Information

Response formats
JSON (default), XML
HTTP method
GET
Response family
Workflow
Header
Authorization: api_key XXXXX


Resource URL

Europe Production Server: https://api.eu.customergauge.com/v4.1/workflow.json

US Production Server: https://api.us.customergauge.com/v4.1/workflow.json

Australia Production Server: https://api.au.customergauge.com/v4.1/workflow.json


How to call

Parameters

number_customergauge
required
CG-ID
Example Values: 12
date_range_from 
 optional
Filter the data from date
 Example Values: 2012-09-01
date_range_to
 optional
Filter the data to date
 Example Values: 2012-10-01
status
 optional
Filter data by status
Example Values: OPEN, CLOSE, PROGRESS


Example Requests

GET (json)
https://api.eu.customergauge.com/v4.1/workflow.json?number_customergauge=26&date_range_from=2012-11-09&date_range_to=2012-11-19&status=CLOSE


GET (xml)
https://api.eu.customergauge.com/v4.1/workflow.xml?number_customergauge=26&date_range_from=2012-11-09&date_range_to=2012-11-19&status=CLOSE


To call this API through cURL:

curl -H "Authorization: api_key XXXXX" -X GET "https://api.eu.customergauge.com/v4.1/workflow.xml?number_customergauge=26&date_range_from=2012-11-09&date_range_to=2012-11-19&status=CLOSE"


Example Result

Message reported on successful operation:

{
  "Data": [{
      "AssignedTo": "",
      "Comment": "",
      "Date": "2012-11-12 21:25:55",
      "Status": "OPEN",
      "User": "API"
    },
    {
      "AssignedTo": "des.patch@directness.net",
      "Comment": "",
      "Date": "2012-11-12 21:25:55",
      "Status": null,
      "User": "API"
    },
    {
      "AssignedTo": "",
      "Comment": "please work on this issue",
      "Date": "2012-11-12 21:25:55",
      "Status": null,
      "User": "API"
    }
  ]
}


Message reported on failed operation:

{
  "Error": {
    "Message": "Workflow not found",
    "Code": 400200
  }
}


Not the API you're looking for?

Related APIs:


Or view: