Get Group by ID

Description

This API will allow you to return a Group within Hi Marley by Group ID.

Service Name	Retrieve Group by Group ID
Service Type	REST
Method	GET
UAT (Sandbox) URL	https://integration.uat.marley.ai/api/groups/:groupId
Production URL	https://integration.himarley.io/api/groups/:groupId
Technical Documentation	View technical documentation with sample request and response payloads hosted on Postman.

 

Table of Contents

• API Request
  • Flow
  • Request Example
  • Request Path Breakdown
• API Response
  • Response Payload Example
  • Response Fields Breakdown
• Common Errors to Handle

API Request

Flow

1. Send API request.
2. Hi Marley responds with the group object data for the Group defined in the request.

Request Example

https://integration.uat.marley.ai/api/groups/05bec2c8-b243-4e88-bd20-80bebf66f5fa

 

Request Path Breakdown

Property	Description	Type	Required	Example
groupId	The identifier generated and assigned to the Group.	string	true	"id": "05bec2c8-b243-4e88-bd20-80bebf66f5fa"

API Response 

Response Payload Example

{
"id": "05bec2c8-b243-4e88-bd20-80bebf66f5fa",
"members": [
   {
    "id": "5bea662f-2026-4bfa-be39-57a9ae6b083f",
    "email": "[e-mail]"
   }
],
"leads": [
   {
    "id": "709d0e28-36b0-46ae-8bb8-3c6a8251ba3d",
    "email": "[e-mail]"
   }
],
"name": “Group A”
}

 

Response Fields Breakdown

Property	Element	Description	Type	Required	Example
id		The identifier generated and assigned to the Group.	string	true	"id": "05bec2c8-b243-4e88-bd20-80bebf66f5fa"
members Array	id	The Hi Marley user ID.	string	true	"id": "5bea662f-2026-4bfa-be39-57a9ae6b083f"
	email	The Hi Marley user email.	string	true	"email": "[e-mail]"
leads Array	id	The Hi Marley user ID.	string	true	"id": "709d0e28-36b0-46ae-8bb8-3c6a8251ba3d"
	email	The Hi Marley user ID.	string	true	"email": "[e-mail]"
subgroups Array	id	The ID of the Group nested under the Group defined in the path parameter.	string	false	"id": "83c4adef-26c5-4fb7-9686-353e087a667a"
	name	The name of the Group nested under the Group defined in the path parameter.	string	false	"name": "Group F"
name		The group name.	string	false	"name": "Group A"

Common Errors to Handle