Get Group Disconnection Request List

{ "meta": { "offset": 0, "page_num": 1, "page_size": 20, "total_records": 1 }, "response": [ { "carrier_id": "5200a894-81c5-4c41-8519-86c32e9a9965", "completed": null, "created": 1557329939, "decided": 1557329939, "effective_end_date": "2025-01-01", "group_id": "f833ac4b-36aa-46f4-826c-0badcfe27922", "group_name": "Widgets R Us", "id": "dd9a1813-34f7-4c7e-86bc-f041f2cbd9a1", "modified": 1557329939, "organization_id": "ca72d1e1-56a6-46ac-b400-a91e1f6b893a", "source_id": null, "source_type": "platform", "status": "processing", "version": "5200a894-81c5-4c41-8519-86c32e9a9965" } ] }

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"

string

Comma-separated list of requested Group Disconnection Request UUIDs

Response

200 - application/json

Successful Response - Returns all matching Group Disconnection Requests