Search for groups
GET https://contacts.8x8.com/api/v1/accounts/:accountId/groups
Search for groups
Request
Path Parameters
Possible values: >= 32 characters and <= 36 characters, Value must match regular expression ^[0-9A-Fa-f]{8}[-]?(?:[0-9A-Fa-f]{4}[-]?){3}[0-9A-Fa-f]{12}$
You must replace {accountId} with the accountid that you want to use.
Query Parameters
Possible values: >= 1 and <= 500
Number of items to include in the response
20
Possible values: >= 0
Page offset. Setting limit to 10 and offset to 0 returns the first 10 items. Increment offset to retrieve more items.
Group name to search for
OK
Schema
- Array [
- ]
items object[]required
Possible values: non-empty
Possible values: non-empty
{
"items":[
{
"id":0,
"contacts":0,
"createdAt":"string",
"name":"string",
"description":"string",
"isBlacklist":true
}
],
"page":0,
"totalPages":0,
"totalCount":0,
"totalFiltered":0,
"hasPreviousPage":true,
"hasNextPage":true
}
Bad request error response
Schema
Error code
Error description
Unique id of error. You can use it as reference when sending enquiries to 8x8 support
Data and time of the error occurence
{
"code":1001,
"message":"Provided subAccountId doesn't belongs to your account",
"errorId":"91b106f0-c0da-4aba-a43a-7af9c5893a80",
"timestamp":"2017-04-19T02:31:19.4297387+00:00"
}
{
"code":1002,
"message":"Invalid MSISDN format (not E.164 international number)",
"errorId":"b4478860-b76c-e811-814e-022a35cc1c71",
"timestamp":"2018-08-04T09:25:40.9235752+00:00"
}
Source: https://developer.8x8.com/connect/reference/groups-api · 8x8 CPaaS Developer Docs. Synced for support deflection.
0 Comments