Description

The Get Participants API allows carriers with Multi-Party Texting to retrieve all active participants of a Hi Marley Case.

Service Name	Get Participants
Service Type	REST
Method	GET
UAT (Sandbox) URL	https://integration.uat.marley.ai/api/case/:caseId/participants
Production URL	https://integration.himarley.io/api/case/:caseId/participants
Technical Documentation	View technical documentation with sample request and response payloads hosted on Postman.

API Request

Request Example

https://integration.uat.marley.ai/api/case/11b2df09-9b5f-471c-8b32-c16b30e08a08/participants

Request Path Breakdown

Property	Description	Type	Required	Example
caseId	The Case ID associated with the Hi Marley Case.	string	true	364ef9bb-fae5-4e2a-a746-cdca465a9c16

Response Payload Example

[
  {
    "participant": {
      "id": "9789b00e-1e2d-41de-8469-50b25544b02b",
      "first": "Jeremie",
      "last": "Quinones",
      "languagePreference": "en",
      "updatedAt": "2025-07-24T13:39:05.239Z",
      "createdAt": "2022-08-01T13:07:00.290Z",
      "email": "jeremie.quinones@himarley.com",
      "mobile": "8449627539"
    },
    "relationship": "",
    "role": "operator",
    "status": "ACTIVE"
  },
  {
    "participant": {
      "id": "5e587fc9-a6ca-4b2b-abf7-c0c4e863753b",
      "first": "Barry",
      "last": "Zito",
      "languagePreference": "en",
      "updatedAt": "2025-07-23T15:36:57.622Z",
      "createdAt": "2024-11-20T15:12:45.356Z",
      "email": "something@email.com",
      "mobile": "+15552327654",
      "optStatus": "OPTED_IN"
    },
    "relationship": "",
    "role": "enduser",
    "status": "ACTIVE"
  }
  ],
  "pagination": {
    "count": 2,
    "currentPage": "/case/11b2df09-9b5f-471c-8b32-c16b30e08a08/participants?pageSize=10&page=1",
    "totalPages": 1,
    "pageSize": 10,
    "nextPage": null,
    "prevPage": null
  }
}

Response Fields Breakdown

Property	Element	Description	Type	Required	Example
participant	id	The Hi Marley UUID generated for the Contact upon creation	string UUID	true	"id": "0e2261fe-e05e-4049-b9d6-505a32272d42"
	first	The given name for the Contact	string	true	"first": "test"
	last	The surname for the Contact	string	true	"last": "name"
	mobile	The mobile number for the Contact	string	false	"mobile": "15552084238"
	optStatus	The Contacts Opt Status	enum	false	"optStatus": "OPTED_IN"
	languagePreference	The language preference for the Contact	enum	false	"languagePreference": "en"
	updatedAt	The time stamp for when the Contact is updated	dateTime	true	"updatedAt": "2024-07-15T15:41:54.684Z"
	createdAt	The time tamp for when the Contact is created	dateTime	true	"createdAt": "2024-07-15T15:41:54.684Z"
relationship		The relationship of the participant to the claimant	enum	true	"relationship": "Parent"
role		The user role	enum	true	"role": "enduser"
status		The participant opt status	enum	true	"status": "PENDING"
participant	currentPage	Indicates path of the current page returned	string	true	"currentPage" : "/case/11b2df09-9b5f-471c-8b32-c16b30e08a08/participants?pageSize=10&page=1"
	totalPages	Indicates number of pages returned	number	true	"totalPages": 1
	pageSize	Max amount of participants that can be displayed on this response (always 10)	number	true	"pageSize": 10
	nextPage	Indicates if more participants can be returned on the next page	string	true	"nextPage": null
	prevPage	Indicates if more participants can be returned on the previous page	string	true	"prevPage"