GET api/v1/addressbook/groups?count={count}&startIndex={startIndex}

This method returns a list of all the groups stored on the customer’s account if no parameters are provided.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
count

Determines how many roles to return. (Default: 20).

string

Required

startIndex

Determines where to start outputting the roles from the list returned from the database. (Default: 0).

string

Required

Body Parameters

None.

Response Information

Resource Description

List of groups.

ResponseOfGroupDetails[]
NameDescriptionTypeAdditional information
Error

Error

None.

ResponseData

ResponseDataOfGroupDetails[]

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": "sample string 1",
        "Groupname": "sample string 2",
        "DateCreated": "sample string 3",
        "DateModified": "sample string 4",
        "Contacts": 5,
        "LastModifiedBy": "sample string 6"
      },
      {
        "GroupID": "sample string 1",
        "Groupname": "sample string 2",
        "DateCreated": "sample string 3",
        "DateModified": "sample string 4",
        "Contacts": 5,
        "LastModifiedBy": "sample string 6"
      }
    ]
  }
}

application/xml, text/xml

Sample:
<ResponseOfArrayOfGroupDetails 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>
      <GroupDetails>
        <GroupID>sample string 1</GroupID>
        <Groupname>sample string 2</Groupname>
        <DateCreated>sample string 3</DateCreated>
        <DateModified>sample string 4</DateModified>
        <Contacts>5</Contacts>
        <LastModifiedBy>sample string 6</LastModifiedBy>
      </GroupDetails>
      <GroupDetails>
        <GroupID>sample string 1</GroupID>
        <Groupname>sample string 2</Groupname>
        <DateCreated>sample string 3</DateCreated>
        <DateModified>sample string 4</DateModified>
        <Contacts>5</Contacts>
        <LastModifiedBy>sample string 6</LastModifiedBy>
      </GroupDetails>
    </Detail>
  </ResponseData>
</ResponseOfArrayOfGroupDetails>