Qodex.ai

List Capacity Groups

GET {{baseUrl}}/v1/configuration/capacitygroup?pageNumber=0&pageSize=20

Request Params

KeyDatatypeRequiredDescription
capacityGroupIdstringThe identifier of the capacity group to search for.
descriptionstringThe description of the capacity group.
e164stringThe e164 bound to the capacity group.
pageNumbernumberThe page number, starting at 0.
pageSizenumberThe page size (max number of entities that are displayed in the response).

HEADERS

KeyDatatypeRequiredDescription
apikeystringAuthentication to Voxbone APIs is handled via key based authentication. You can manage your API key on our platform under Account Settings. Please use our API quickstart guide for more help.
Acceptstring

RESPONSES

status: OK

{"capacityGroups":[{"capacityGroupId":"\u003cinteger\u003e","maximumCapacity":"\u003cinteger\u003e","description":"\u003cstring\u003e","amountOfDidsMapped":"\u003cinteger\u003e"},{"capacityGroupId":"\u003cinteger\u003e","maximumCapacity":"\u003cinteger\u003e","description":"\u003cstring\u003e","amountOfDidsMapped":"\u003cinteger\u003e"}],"resultCount":"\u003cinteger\u003e"}