Skip to main content
GET
/
api
/
v2
/
Group
{
  "ErrorCode": 123,
  "ErrorDescription": "<string>",
  "Data": [
    {}
  ],
  "Data[].GroupId": 123,
  "Data[].GroupName": "<string>",
  "Data[].ContactCount": 123
}

Get Groups

Retrieve a list of all contact groups in your account.
curl -X GET "https://accounts.netvox.ng/api/v2/Group?ApiKey=YOUR_API_KEY&ClientId=YOUR_CLIENT_ID" \
  -H "Content-Type: application/json"

Parameters

ApiKey
string
required
Your API key for authentication
ClientId
string
required
Your client identifier for authentication

Response

ErrorCode
number
Error code (0 for success)
ErrorDescription
string
Description of the result
Data
array
Array of group objects
Data[].GroupId
number
Unique identifier for the group
Data[].GroupName
string
Name of the group
Data[].ContactCount
number
Number of contacts in the group

Success Response

{
  "ErrorCode": 0,
  "ErrorDescription": "Success",
  "Data": [
    {
      "GroupId": 33,
      "GroupName": "JGJ",
      "ContactCount": 21
    },
    {
      "GroupId": 50,
      "GroupName": "6Y5",
      "ContactCount": 0
    }
  ]
}

Use Cases

  • Group management: View all available contact groups
  • Contact organization: Organize contacts for targeted messaging
  • Bulk messaging: Send messages to specific groups
  • Analytics: Track group sizes and engagement