Skip to content
Blue Dots EconomyBlue Dots EconomyDocumentation
admin

/api/v1/admin/participant (GET)

GET
/api/v1/admin/participant
curl --request GET \
  --url https://dpg.example.com/api/v1/admin/participant \
  --header 'x-acting-org-id: example' \
  --header 'x-api-key: <x-api-key>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
email
string format: email
/^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$/
phone_number
string
/^\+?\d{10,15}$/
network
string
>= 1 characters

Header Parameters

Section titled “Header Parameters”
x-acting-org-id
required
string

Organization this request acts on behalf of. Required for admin/aggregator operations.

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
user_id
required
string
nullable
compliance
required
Array<object>
object
key
required
string
Allowed values: user_terms user_privacy has_age
value
required
boolean
items
required

Ordered newest first by created_at (ties broken by item_id), so a caller that reads only the head of the list gets the participant’s most recent profile.

Array<object>
object
item_id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
item_network
required
string
item_domain
required
string
item_type
required
string
lifecycle_status
string
profile_consent_accepted
boolean
item_state
required
object
key
additional properties
item_locations
required
Array<object>
object
lat
required
number
>= -90 <= 90
lng
required
number
>= -180 <= 180
label
string
created_at
required
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$/
updated_at
required
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$/
Example
{
  "compliance": [
    {
      "key": "user_terms"
    }
  ]
}