GET api/v1/addressbook/groups/{groupID}

This method returns a group stored on any account.

Request Information

URI Parameters

Name	Description	Type	Additional information
groupID	Unique indentifier for the group in question.	globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

Group Details.

TwoSms.CustomerPortalRole.API.Misc.ResponseOfTwoSms.CustomerPortalRole.API.AddressBooks.GroupDetails

Name	Description	Type	Additional information
Error		TwoSms.CustomerPortalRole.API.Misc.Error	None.
ResponseData		TwoSms.CustomerPortalRole.API.Misc.ResponseDataOfTwoSms.CustomerPortalRole.API.AddressBooks.GroupDetails	None.

Response Formats

application/json, text/json

Sample:

{
  "Error": {
    "ErrorCode": "sample string 1",
    "ErrorReason": "sample string 2"
  },
  "ResponseData": {
    "Identification": {
      "UserId": "sample string 1"
    },
    "Result": "sample string 1",
    "Detail": {
      "GroupID": "83e84c76-58d0-4470-a669-ca78ce000089",
      "Groupname": "sample string 2",
      "DateCreated": "2024-11-21T10:23:14.4947221+00:00",
      "DateModified": "2024-11-21T10:23:14.4947221+00:00",
      "Contacts": 4,
      "LastModifiedBy": "sample string 5",
      "PermissionDetails": "sample string 6"
    }
  }
}

application/xml, text/xml

Sample:

<ResponseOfGroupDetails xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Error>
    <ErrorCode>sample string 1</ErrorCode>
    <ErrorReason>sample string 2</ErrorReason>
  </Error>
  <ResponseData>
    <Result>sample string 1</Result>
    <Identification>
      <UserId>sample string 1</UserId>
    </Identification>
    <Detail>
      <GroupID>83e84c76-58d0-4470-a669-ca78ce000089</GroupID>
      <Groupname>sample string 2</Groupname>
      <DateCreated>2024-11-21T10:23:14.4947221+00:00</DateCreated>
      <DateModified>2024-11-21T10:23:14.4947221+00:00</DateModified>
      <Contacts>4</Contacts>
      <LastModifiedBy>sample string 5</LastModifiedBy>
      <PermissionDetails>sample string 6</PermissionDetails>
      <PermissionLevel>7</PermissionLevel>
      <GroupAccountID>476082ac-4cb3-4a24-b308-57dfb1c76ff5</GroupAccountID>
      <ParentGroupID>6500e95b-c16e-4b14-ae46-934dc8c89412</ParentGroupID>
    </Detail>
  </ResponseData>
</ResponseOfGroupDetails>