Integrations

The Match API allows you to create, retrieve, modify, and delete segment matches.

Available since: v2.23.0

Retrieves a list of integrations based on their status and participant ID.

Endpoint

GET /api/integrations/integration

Headers

• Accept: application/vnd.blockgraph.v1+json
• Authorization: Bearer {access-token}

Request Body

Name	In	Type	Required	Description
params	query	IntegrationQueryParameters	true	none

Possible Responses

Status	Meaning	Description	Schema
200	OK	A ResponseEntity containing a list of Integration objects if found, or a 404 Not Found response if no integrations match the criteria	IntegrationResponse
400	Bad Request	Bad Request	Inline
500	Internal Server Error	Internal Server Error	Description of the integration

Example Request

curl -X GET https://api.{participant id}.blockgraph.app/api/integrations/integration?params=status,PENDING,purpose,ACTIVATION,page,1000,pageSize,10 \
  -H 'Accept: application/vnd.blockgraph.v1+json' \
  -H 'Authorization: Bearer {access-token}'

Response

200 Response

{
  "integrations": [
    {
      "id": 0,
      "integrationName": "string",
      "purpose": "string",
      "activationApi": "string",
      "destinationType": "string",
      "minimumSegmentSize": "string",
      "status": "PENDING",
      "deliveryScopes": [
        "CABLE"
      ],
      "includeNone": true,
      "pendingUpdates": true,
      "includeTriggerFile": true
    }
  ],
  "page": 0,
  "pageSize": 0,
  "hasMore": true
}

400 Response

Integrationqueryparameters

Name	Type	Required	Restrictions	Description
status	string	true	accepted value: PENDING, ENABLED	status of the integrations
purpose	string	true	accepted value: ACTIVATION, EXPORT, UNIVERSE_EXPORT, GENERIC_DATA_EXPORT, BATCH_IDENTITY_RESOLUTION;	none
page	integer	0 ≤ value ≤ 1000	Page number for pagination.
pageSize	integer	10 ≤ value ≤ 100	Number of items per page.	none