List

Description

Retrieve a list of subscribers of a case.

Request

HTTP Method: GET

Parameter Description
case_id The ID of the case.
per_page Optional Set the number of results returned per page. Defaults to 20.
page Optional Specify the page of results to return if there are multiple pages. Defaults to page 1. 
curl -X GET \
  https://<<META.tenant.domain>>/api/v2/cases/<<case_id>>/subscribers \
  -H 'content-type: application/json' \
  -H 'Authorization: Bearer <<CREDENTIAL.tines_api_key>>'

Response

A successful request will return a JSON object with the subscribers.

Field description

Parameter Description
case_id The ID of the case.
subscribers An array of users subscribed to the case.
Subscribers parameter Description
id The ID of the case subscriber.
user_id The user ID.
first_name The user's first name.
last_name The user's last name.
email The user's email address.
avatar_url The user's avatar url.

Sample response

{
  "case_id": 42,
  "subscribers": [
    {
      "id": "12",
      "user_id": "1",
      "first_name": "Jane",
      "last_name": "Doe",
      "email": "jane@tines.io",
      "avatar_url": "example.com/avatar"
    }
  ],
  "meta": {
    "current_page": "https://<<META.tenant.domain>>/api/v2/cases/42/subscribers?per_page=20&page=1",
    "previous_page": null,
    "next_page": null,
    "next_page_number": null,
    "per_page": 20,
    "pages": 1,
    "count": 1
  }
}
Was this helpful?