Let the platform do the work
SugarClubContact+1 (877) 842-7276

/Contact/:record/Cases GET

Overview

Get a contact's related cases, filtered by an expression, which are accessible to a contact with portal visibility.

Summary

This endpoint will return a set of cases filtered by an expression which are accessible to a contact with portal visibility. The filter can be applied to multiple fields and have multiple and/or conditions in it. Alternatively, you may use an existing filter by specifying its ID. If both a filter definition and a filter ID are passed, the two filters will be joined with an
AND. Care will need to be taken to make sure that any filters used have appropriate indexes on the server side, otherwise the runtime of the endpoint will be very long.

Request

GET /Contact/:id/Cases

Request Arguments

Name Type Description Required
filter String See the Filter API for details. False
filter_id String Identifier for a pre-existing filter. See the Filter API for details. False
max_num Integer Max number of records that can be returned. Default is 20, unless overruled by your Sugar configuration. False
offset Integer The number of records to skip over before records are returned. Default is 0. False
fields String Comma delimited list of fields to return. Each field may be represented either by string, or by map containing field name and additional field parameters (applicable to link and collection fields). The field's ID and date_modified will always be returned. For more details on additional field parameters, see the Relate API and Collection API. False
order_by String See the Filter API. False
deleted Boolean Boolean to show deleted records in the result set. False

Response

{
  "next_offset": -1,
  "records": [
    {
      "id": "d509b3da-29f6-7b23-7cce-56fab1a6335b",
      "name": "Need help",
      "date_modified": "2016-03-29T09:46:00-07:00",
      "_acl": {
        "fields": {}
      },
      "_module": "Cases"
    },
    {
      "id": "cc4982cd-0bdf-bad4-d079-56fab4bdddf1",
      "name": "Having trouble",
      "date_modified": "2016-03-29T09:57:58-07:00",
      "_acl": {
        "fields": {}
      },
      "_module": "Cases"
    }
  ]
}

Response Arguments

Name Type Description
next_offset Integer Displays the next offset for retrieval of additional results. -1 will be returned when there are no more records.
records Array An array of results containing matched records.

Change Log

Version Change
v11 Added /Contact/:record/Cases GET endpoint.

Topics