Partners
Retrieve a Partner
Retrieves details of a partner by their ID.
Endpoint
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer | Yes | The ID of the partner |
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.
{
"name": "Partner name",
"id": "Partner ID",
"features": [
{
"type": "featureType",
"signals": [
"signal"
]
}
]
}
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/partners/{id}" \
-H "Accept: application/vnd.blockgraph.v1+json" \
-H "Authorization: Bearer $access_token"
List all Partners
Retrieves a list of partners based on optional filtering parameters.
Endpoint
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| featureType | string | No | Filter partners by feature type |
| signal | string | No | Filter partners by signal type |
Allowed Values
featureType: SEGMENT_UPLOAD, SEGMENT_SHAREsignal: IP, IDFA, AAID, STBID, EMAIL, ADDRESS, PARTNER_RECORD_ID, BGID, RECORD_ID
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 partners matching the specified criteria.
{
"partners": [
{
"name": "Partner name",
"id": "Partner ID",
"features": [
{
"type": "featureType",
"signals": [
"signal"
]
}
]
}
]
}
400 Bad Request
Returned when the request is invalid.
500 Internal Server Error
Returned when an unexpected error occurs on the server.