GET
/
api
/
v1
/
group_disconnection_requests
/
{group_disconnection_request_id}
curl --request GET \
  --url https://fulfillment.noyo.com/api/v1/group_disconnection_requests/{group_disconnection_request_id}
{
  "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": "Besta LLC",
  "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"
}

Path Parameters

group_disconnection_request_id
string
required

The unique identifier of the group disconnection request you want to retrieve

Response

201 - application/json
Successful Response - Returns the GroupDisconnectionRequest
carrier_id
string
required

Unique identifier for the carrier to be disconnected from

created
integer
required

The date the record was created

group_name
string
required

Name of the group to be disconnected from

id
string
required

Unique identifier of the record in Noyo

modified
integer
required

The date the record was last updated

organization_id
string
required

Unique identifier for organization associated with the request

source_id
string
required

If applicable, the ID associated with the source of the disconnection request

source_type
string
required

The source of the disconnection request

status
string
required

The status of the disconnection request

version
string
required

Current version of the record

completed
integer

Timestamp at which the disconnection was completed

decided
integer

Timestamp at which the platform recorded a decision on the disconnection

effective_end_date
string

The date at which the disconnection will take effect

group_id
string

Unique identifier for the group to be disconnected. May be missing if group has already been disconnected.