Get a list of contact groups

Retrieve a paged collection of contact groups (required scope contacts:read)

Query Parameters

sortBy ContactGroupSortOptions

Possible values: [name]

The field to sort items in the page by

direction SortDirection

Possible values: [ascending, descending]

The direction to apply the sort

name string

Only return contact groups where name matches or starts with the value provided

id int64[]

Only return contact groups where id matches the value(s) provided

pageNumber int32

Possible values: >= 1 and <= 2147483

The page number being requested (minimum: 1, maximum: 2147483)

pageSize int32

Possible values: >= 1 and <= 1000

The page size being requested (minimum: 1, maximum: 1000)

Header Parameters

Customer-Id int64 required

The customer identifier

Responses

• 200
• 400
• 403
• 500

---

Success

application/json

Schema

Example (from schema)

---

Schema

items object[]
The items returned for the requested page
Array [
id int64
The unique identifier of the contact group
name string
The name of the contact group
]
pageNumber int32

The page number of the response where 1 is the first page

pageSize int32

The number of items requested for the current page

pageItemCount int32

The number of items returned in the current page

{
  "items": [
    {
      "id": 5514123,
      "name": "High value customers"
    }
  ],
  "pageNumber": 2,
  "pageSize": 100,
  "pageItemCount": 55
}

Bad Request

application/problem+json

Schema

Example (from schema)

---

Schema

type string nullable

A URI reference [RFC3986] that identifies the problem type

title string nullable

A short, human-readable summary of the problem type

status int32 nullable

The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem

detail string nullable

A human-readable explanation specific to this occurrence of the problem

instance string nullable

A URI reference that identifies the specific occurrence of the problem

{
  "type": "https://example.com/probs/out-of-credit",
  "title": "You do not have enough credit",
  "status": 403,
  "detail": "Your current balance is 30, but that costs 50",
  "instance": "/account/12345/msgs/abc"
}

Forbidden

application/problem+json

Schema

Example (from schema)

---

Schema

type string nullable

A URI reference [RFC3986] that identifies the problem type

title string nullable

A short, human-readable summary of the problem type

status int32 nullable

The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem

detail string nullable

A human-readable explanation specific to this occurrence of the problem

instance string nullable

A URI reference that identifies the specific occurrence of the problem

{
  "type": "https://example.com/probs/out-of-credit",
  "title": "You do not have enough credit",
  "status": 403,
  "detail": "Your current balance is 30, but that costs 50",
  "instance": "/account/12345/msgs/abc"
}

Server Error

application/problem+json

Schema

Example (from schema)

---

Schema

type string nullable

A URI reference [RFC3986] that identifies the problem type

title string nullable

A short, human-readable summary of the problem type

status int32 nullable

The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem

detail string nullable

A human-readable explanation specific to this occurrence of the problem

instance string nullable

A URI reference that identifies the specific occurrence of the problem

{
  "type": "https://example.com/probs/out-of-credit",
  "title": "You do not have enough credit",
  "status": 403,
  "detail": "Your current balance is 30, but that costs 50",
  "instance": "/account/12345/msgs/abc"
}

Loading...