Other

Query consumer data for a product using a consent ID.

Resolves the consumer via the consent record, fetches their data, and records a QueryEvent for history tracking.

Parameters

product_id : UUID The product to query against.

request : ProductQueryInput The query input containing consent_id.

deps : GraphQLServiceDeps Injected GraphQL service dependencies.

Returns

result : ProductQueryOutput The query result with consumer data and event ID.

Examples

POST /api/v1/products/{product_id}/query
{
  "consent_id": "consent-john-doe"
}

POST

products

{product_id}

query

Query consumer data for a product using a consent ID.

curl --request POST \
  --url https://api.example.com/products/{product_id}/query \
  --header 'Content-Type: application/json' \
  --data '
{
  "consent_id": "<string>",
  "profile_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

{
  "query_event_id": "<string>",
  "data": {},
  "errors": [
    {}
  ]
}

Path Parameters

product_id

string<uuid>

required

Body

application/json

profile_id

string<uuid> | null

Response

Successful Response

query_event_id

string

required

data

Data · object

errors

Errors · object[] | null

Create a business consent record (direct, server-to-server). Returns a consent_id used for all subsequent queries.Create a business consent record (direct, server-to-server). Returns a consent_id used for all subsequent queries.

Query consumer data for a product using a consent ID.

curl --request POST \
  --url https://api.example.com/products/{product_id}/query \
  --header 'Content-Type: application/json' \
  --data '
{
  "consent_id": "<string>",
  "profile_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

{
  "query_event_id": "<string>",
  "data": {},
  "errors": [
    {}
  ]
}

Overview

Other

Path Parameters

Body

Response