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

List participants

Organization-scoped participant read. Requires participants.read. Unknown or repeated query parameters are rejected. Contact data, birth dates and private notes are omitted. Linked profiles follow provider consent.

GET/participants
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.

Query parameters
limitinteger

Maximum records per page. A page may be empty with a non-null cursor; continue until next_cursor is null.

min 1 · max 100 · default: 25
cursorstring

Opaque cursor from this resource and organization. No snapshot isolation across pages.

min length 1 · max length 16384
Responses
200

Successful operation.

dataParticipant[]required
Show properties
Array of Participant
idstringrequired

Opaque Soljio ID. Do not parse or synthesize.

min length 1 · max length 256
organization_idstringrequired

Opaque Soljio ID. Do not parse or synthesize.

min length 1 · max length 256
statusstringrequired
updated_atstring<date-time>required
objectstringrequired
created_atstring<date-time>required
display_namestringrequired
given_namestring
family_namestring
provider_linkobject
Show properties
statusstringrequired
consent_statusstring
provider_visibilitystring
request_idstring<uuid>required
next_cursorstring | nullrequired
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
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
Parameters
Request
curl -X GET 'https://api.soljio.com/v0/participants' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "data": [
    {
      "id": "string",
      "organization_id": "string",
      "status": "string",
      "updated_at": "2019-08-24T14:15:22Z",
      "object": "participant",
      "created_at": "2019-08-24T14:15:22Z",
      "display_name": "string",
      "given_name": "string",
      "family_name": "string",
      "provider_link": {
        "status": "string",
        "consent_status": "string",
        "provider_visibility": "string"
      }
    }
  ],
  "request_id": "266ea41d-adf5-480b-af50-15b940c2b846",
  "next_cursor": "string"
}

Was this page helpful?