Search Cases

Lists Cases using the specified criteria

GET /api/v2/case

Input Parameters

Name	Type	Description
count	integer	Retrieve count results
index	integer	Retrieve results starting from this position in the result set
order_by	string	Order results based on this attribute
order_dir	string	Either ASC or DESC
contact_id	string	Select cases from a particular contact id
campaign_id	string	Select cases from a particular campaign id
state	string	Select cases that have a particular state
source	string	Select cases that have a particular source
with_tag	string	Select cases that have a particular tag
without_tag	string	Select cases that do not have a particular tag
created_since	date	Select cases that were created after a particular date and time. (use date format: 2015-05-11T16:03:57-0300)
updated_since	date	Select cases that have been updated after a particular date and time. (use date format: 2015-05-11T16:03:57-0300)

Response Sample

Status: 200 OK

{
  "id": 203,
  "first_open_date": "2015-03-16T22:13:03-0300",
  "reopened": false,
  "last_open_date": "2015-03-16T22:13:03-0300",
  "inbox_date": "2015-03-17T08:00:00-0300",
  "campaign": {
    "id": 2,
    "name": "gg"
  },
  "source": "email",
  "private": true,
  "subject": "Necesito ayuda !!!",
  "contact": {
    "id": 43,
    "name": "Juan Perez",
    "first_name": "Juan",
    "last_name": "Perez",
    "client_id": "4234534625",
    "extended_value": "53242354352253",
    "cases": 3,
    "profiles": [
      {
        "id": 113,
        "source": "email",
        "name": "Juan Perez",
        "ext_id": "jp@socialgateway.net",
        "user_name": "aram@socialgateway.net",
        "tags": [
          "spam"
        ],
        "creation_date": "2015-02-20T16:32:51-0300",
        "update_date": "2015-05-11T15:53:54-0300",
        "updated_by": "api"
      },
      {
        "id": 292,
        "source": "twitter",
        "name": "Juan Perez",
        "ext_id": "42416688",
        "user_name": "juanperez7010",
        "image_url": "http://pbs.twimg.com/profile_images/542701207/165901190_9e133991fb_o_normal.jpg",
        "about": "",
        "location": "Mexico",
        "followers": 436,
        "following": 2000,
        "creation_date": "2015-05-11T16:03:57-0300"
      },
      {
        "id": 5,
        "source": "facebook",
        "name": "Gatu Bela",
        "ext_id": "100003438147119",
        "user_name": "gatu.bela.129",
        "gender": "female",
        "image_url": "http://graph.facebook.com/100003438147119/picture",
        "tags": [
          "aaaee"
        ],
        "creation_date": "2015-01-08T00:39:42-0300",
        "update_date": "2015-05-11T16:04:55-0300",
        "updated_by": "support"
      }
    ],
    "url": "http://master.local2.socialgateway.net:8080/contact/43",
    "tags": [
      "spam"
    ],
    "notes": [
      {
        "date": 1431371012000,
        "text": "este cliente es ficticio",
        "userName": "support"
      }
    ],
    "creation_date": "2015-02-20T16:32:51-0300",
    "update_date": "2015-05-11T16:03:57-0300",
    "updated_by": "support"
  },
  "state": "Arrived",
  "credits": 0,
  "we_did_not_reply_since_date": "2015-03-16T22:13:03-0300",
  "handling_ms": 0,
  "sla_seconds": 259200,
  "messages_sent": 0,
  "messages_received": 1,
  "messages": 1,
  "url": "http://master.local2.socialgateway.net:8080/case/203",
  "tags": [
    "spam"
  ],
  "creation_date": "2015-03-19T00:35:28-0300",
  "update_date": "2015-05-11T16:03:57-0300",
  "updated_by": "support"
}