Support

Retrieve all cases.

Optionally filtered by search string, tag, and/or assignment. Assigned cases can be filtered by passing in the AssignedToPersonClientIdentifier, which is the Uid of the person the case is assigned to.

get/api/v1/support/cases

Request

  • Base URL: https://go.outseta.com
  • URL: https://go.outseta.com/api/v1/support/cases
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization

Query parameters

qstring nullable

Search string

tagUidstring nullable

Uid of tag that is on the case

limitinteger

Requested page size. The server caps it at 100, or 25 when requested fields expand child objects or require additional queries; metadata.limit reports the applied value. Use offset=1 for the second page.

offsetinteger

Zero-based page number, not a record offset. With limit=50, the second page is offset=1; offset=50 is page index 50 (records 2501-2550).

Response

Example response

{
  "metadata": {
    "limit": 0,
    "offset": 0,
    "total": 0
  },
  "items": [
    {
      "Uid": "string",
      "_objectType": "string",
      "Created": "string",
      "Updated": "string",
      "ActivityEventData": {},
      "SubmittedDateTime": "string",
      "LastActivity": "string",
      "FromPerson": {},
      "AssignedToPersonClientIdentifier": "string",
      "Subject": "string",
      "Body": "string",
      "UserAgent": "string",
      "Status": 1,
      "Source": 1,
      "CaseHistories": [],
      "CaseTags": [],
      "HasUnread": false,
      "IsOnline": false,
      "LastCaseHistory": {},
      "Participants": "string",
      "RecaptchaToken": "string",
      "RecaptchaSiteKey": "string",
      "Score": 0
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.