Groups
Retrieve a Group
Retrieves details of a group by group ID.
Endpoint
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | Yes | The ID of the group |
Request Headers
| Name | Required | Description |
|---|---|---|
| Accept | Yes | Must be application/vnd.blockgraph.v1+json |
| Authorization | Yes | Bearer token for authentication |
Response
200 OK
Returns information about the partner if found.
{
"groupId": 10452,
"groupName": "IDFA Segment Match Group for Cypress Smoke Test 1 4-8-2025",
"description": "Smoke Test",
"features": [
"AGGREGATED_MATCH"
],
"groupMembers": [
3051,
3053
],
"groupAccess": [
31000088
],
"parameters": {
"roles": null
},
"deliveryScopes": [
"HIGH_SPEED_DATA",
"VOD_CAPABLE",
"LINEAR_ADDRESSABLE",
"HIGH_SPEED_INTERNET"
]
}
400 Bad Request
Returned when the request is invalid.
404 Not Found
Returned when the partner with the specified ID is not found.
500 Internal Server Error
Returned when an unexpected error occurs on the server.
Example Request
curl -X GET "https://api.{participant id}.blockgraph.app/api/groups/{id}" \
-H "Accept: application/vnd.blockgraph.v1+json" \
-H "Authorization: Bearer $access_token"
List all Groups with groupFeature
Retrieves a list of partners based on optional filtering parameters.
Endpoint
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| groupFeature | string | No | Filter group by feature type |
Allowed Values
featureType: AGGREGATED_MATCH, EXPOSURE_DATA_SHARE_APPROVAL
Request Headers
| Name | Required | Description |
|---|---|---|
| Accept | Yes | Must be application/vnd.blockgraph.v1+json |
| Authorization | Yes | Bearer token for authentication |
Response
200 OK
Returns a list of group matching the specified criteria.
{
"group": [
{
"groupId": 10452,
"groupName": "IDFA Segment Match Group for Cypress Smoke Test 1 4-8-2025",
"description": "Smoke Test",
"features": [
"AGGREGATED_MATCH"
],
"groupMembers": [
3051,
3053
],
"groupAccess": [
31000088
],
"parameters": {
"roles": null
},
"deliveryScopes": [
"HIGH_SPEED_DATA",
"VOD_CAPABLE",
"LINEAR_ADDRESSABLE",
"HIGH_SPEED_INTERNET"
]
},
{
"groupId": 10402,
"groupName": "IDFA Segment Match Group for Ampersand 4-8-2025",
"description": "Smoke Test",
"features": [
"AGGREGATED_MATCH"
],
"groupMembers": [
3051,
3053
],
"groupAccess": [
3052
],
"parameters": {
"roles": null
},
"deliveryScopes": [
"HIGH_SPEED_DATA",
"VOD_CAPABLE",
"LINEAR_ADDRESSABLE",
"HIGH_SPEED_INTERNET"
]
}
]
}
400 Bad Request
Returned when the request is invalid.
500 Internal Server Error
Returned when an unexpected error occurs on the server.