GET groups/:group id

Description

Returns a Group.

Resource URL

  GET https://api.socialidnow.com/v1/marketing/groups/:group_id

Parameters

URL Parameters

group_id	required	group identifier.

Authentication

This API requires Account authentication. See Authentication.

Response

Response Status

ok (200)	The request was successful.
unauthorized (401)	The authentication is wrong. See Authentication.
forbidden (403)	The account does not have access to this group.
internal_server_error (500)	An unknown error happened.

Response Body

The following fields are returned:

id	group identifier.
name	group name.
category	group category.
description	group description.
child_group_ids	array of child group identifiers.
parent_group_ids	array of parent group identifiers.
manager_group_ids	array of manager group identifiers.
managed_group_ids	array of managed group identifiers.
created_at	date of group creation.
updated_at	date of group latest update.

Examples

Request

curl -X GET 'https://api.socialidnow.com/v1/marketing/groups/1' \
  --user 138:e8b9ca24f1b590af67e6271297d6e1f7226625d61c5b5daa1b2f215464e292cf

Response

Response Headers

HTTP/1.1 200 Ok
Status: 200

Response Body

{
  "id": 1,
  "name": "Group A",
  "category": "Category X",
  "description": "My Group A description",
  "child_group_ids": [10,20,30],
  "parent_group_ids": [30,40,50],
  "manager_group_ids": [60,70,80],
  "managed_group_ids": [90,100,110],
  "created_at": "2022-11-17T19:30:00Z",
  "updated_at": "2022-11-17T19:30:00Z"
}