Skip to main content
GET
List contact groups
SystemUser accessible. Required policy actions:
  • ContactGroupService:getContactGroupsForTarget

Authorizations

Authorization
string
header
required

JWT bearer token obtained from POST /auth/system-login using your client credentials.

Query Parameters

contactGroupFor
enum<string>

Target type. Must be given together with contactGroupForId — omit both to search all contacts by label instead.

Available options:
customer,
entity,
contract,
invoice
contactGroupForId
string

Id of the target record.

q
string

Label search text. Only used on the org-wide (no target) branch.

page
integer
default:1

Page number (1-indexed). Only used on the org-wide branch.

limit
integer
default:25

Results per page. Only used on the org-wide branch.

sortBy
string

Sort field. Only used on the org-wide branch.

sortOrder
string

Sort direction. Only used on the org-wide branch.

Response

Success

status
string
Example:

"success"

message
string
Example:

"Success"

data
object | null

Endpoint-specific payload (object, array, or null)