Skip to content
Soljio Docs
Esc
↑↓navigate↵open⌘Jpreview

List participant profiles.

List participant profiles. An organization-scoped read using JSON filter arguments; requires participants.details.read. Pagination cursors must be reused only with the same organization, operation and filters.

POST/queries/list_participant_profiles
Authorization
AuthorizationBearer token (soljio_sk_<secret>) · headerrequired

Organization-scoped service token created by an owner/admin. Scope requirements are in x-required-scopes; these are service-token grants, not OAuth scopes. Revoked, expired, unknown and suspended-organization credentials all return 401.

Request body
requiredapplication/json
object
Responses
200

Successful read.

dataobject[]required
Show properties
Array of object
date_of_birthstring
display_namestringrequired
family_namestring
given_namestring
householdobject | nullrequired
Show properties
Any of:
null
null
object
idstringrequired

Opaque Soljio resource ID.

min length 1
namestringrequired
statusstringrequired
household_membersobject[]required
Show properties
Array of object
display_namestring
emailstring
idstringrequired

Opaque Soljio resource ID.

min length 1
phonestring
relationshipstring
rolestringrequired
Show properties
Any of:
string
string
string
string
string
string
string
string
statusstringrequired
Show properties
Any of:
string
string
string
string
string
string
idstringrequired

Opaque Soljio resource ID.

min length 1
provider_linkobject | nullrequired
Show properties
Any of:
null
null
object
consent_statusstring
Show properties
Any of:
string
string
string
string
string
string
string
string
external_referencestring
idstringrequired

Opaque Soljio resource ID.

min length 1
provider_visibilitystring
Show properties
Any of:
string
string
string
string
string
string
statusstringrequired
Show properties
Any of:
string
string
string
string
statusstringrequired
Show properties
Any of:
string
string
string
string
string
string
request_idstring<uuid>required
400

invalid_request

errorobjectrequired
Show properties
codestringrequired
Allowed:invalid_request
messagestringrequired
request_idstring<uuid>required
401

unauthorized

errorobjectrequired
Show properties
codestringrequired
Allowed:unauthorized
messagestringrequired
request_idstring<uuid>required
403

forbidden

errorobjectrequired
Show properties
codestringrequired
Allowed:forbidden
messagestringrequired
request_idstring<uuid>required
404

not_found

errorobjectrequired
Show properties
codestringrequired
Allowed:not_found
messagestringrequired
request_idstring<uuid>required
405

method_not_allowed

errorobjectrequired
Show properties
codestringrequired
Allowed:method_not_allowed
messagestringrequired
request_idstring<uuid>required
409

conflict, idempotency_conflict

errorobjectrequired
Show properties
codestringrequired
Allowed:conflictidempotency_conflict
messagestringrequired
request_idstring<uuid>required
413

payload_too_large

errorobjectrequired
Show properties
codestringrequired
Allowed:payload_too_large
messagestringrequired
request_idstring<uuid>required
415

unsupported_media_type

errorobjectrequired
Show properties
codestringrequired
Allowed:unsupported_media_type
messagestringrequired
request_idstring<uuid>required
429

rate_limited

errorobjectrequired
Show properties
codestringrequired
Allowed:rate_limited
messagestringrequired
request_idstring<uuid>required
500

internal_error

errorobjectrequired
Show properties
codestringrequired
Allowed:internal_error
messagestringrequired
request_idstring<uuid>required
Try it
Server
Authorization
Bodyapplication/json
Request
curl -X POST 'https://api.soljio.com/v0/queries/list_participant_profiles' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{}'
Response
{
  "data": [
    {
      "date_of_birth": "string",
      "display_name": "string",
      "family_name": "string",
      "given_name": "string",
      "household": {},
      "household_members": [
        {
          "display_name": "string",
          "email": "string",
          "id": "string",
          "phone": "string",
          "relationship": "string",
          "role": "guardian",
          "status": "active"
        }
      ],
      "id": "string",
      "provider_link": {},
      "status": "active"
    }
  ],
  "request_id": "266ea41d-adf5-480b-af50-15b940c2b846"
}