Skip to main content
GET
List Group Disconnection Requests

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page_size
integer

The max size of each page of results

offset
integer

The integer offset at which to start the page. Possible values are 0 to total_records - 1

status
string

Status of the group Disconnection requests for which you would like to filter.

Example:

"created"

carrier_id
string<uuid>

Comma-separated list of carrier UUID's for which you would like to view group disconnection requests

Example:

"2613a221-d3c8-4c8a-86d5-e7e885fd1da9"

group_id
string
min_effective_end_date
string
max_effective_end_date
string

Search by group name

Example:

"Widgets R Us"

source_type
string

Source type to filter by

Example:

"platform"

id
string

Comma-separated list of requested Group Disconnection Request UUIDs

Response

200 - application/json

Successful Response - Returns all matching Group Disconnection Requests

meta
object
required

Metadata associated with the response data

response
object[]
required

List of group disconnection request results