Sign in

v1

latestOpenAPI 3.1.02026-07-241653251.3 MB
Query Participants

List participants

Returns a list of all participants to which you are associated.

get/participants

Query parameters

participant_codestring
Example:ABCDEF

Filter by a specific participant code. Always 6 uppercase alphanumeric characters.

pagenumber
Example:1

Page number for pagination (starts at 1).

relationship_typestring

Filters for a specific relationship_type

emailstring

Filters for a specific email

minors'true' | 'false'

When set to the string "true", restricts results to minor participants only.

entity_type'corporation' | 'llc' | 'partnership' | 'sole_proprietorship' | 'individual'

Filters entity participants by their declared entity type.

status'submitted' | 'pending_approval' | 'approved' | 'rejected' | 'locked' | 'pending_unlock' | 'pending_disable' | 'disabled' | 'divested' | 'closed'

Filters for a specific status

Headers

X-SCX-SIGNEDstring required

HMAC-SHA256 signature of the request, base64-encoded. See the Authentication guide for the exact signing formula.

X-SCX-TIMESTAMPstring required
Example:1678901234

Current Unix timestamp in seconds. Must be within 60 seconds of server time or the request is rejected.

Response

Successfully retrieved paginated list of participants with optional filters: relationship_type, email, status.

pagenumber required

Current page number (1-indexed)

page_sizenumber

Number of items per page

total_pagesnumber required

Total number of pages available

Example response

{
  "page": 1,
  "page_size": 15,
  "total_pages": 1
}