List Contract Participants

Returns the AI trainers on a contract whose job is linked by this install. Use it to provision workspace members — or to re-resolve a workEmail that was absent from a webhook payload.

Requirements: participants:read scope. The workEmail field additionally requires the participants:email scope and the install’s PII consent — see privacy and Work Email.

Request

contractIdstringpathrequired

The contract ID, from list contracts or a contract.started event.

Response

contractIdstring

The contract these participants belong to.

participantsobject[]

The AI trainers on the contract.

Participant fields

opentrainUserIdstring

Stable OpenTrain user ID — use it as your cross-reference key.

displayNamestring | null

Display name, masked to first name + last initial (for example "Maria S."). Full last names never leave the platform.

countrystring | null

Country.

profileUrlstring

Public OpenTrain profile URL.

workEmailstring

Platform-issued @opentrain.work Work Email. Present only when the install has PII consent and the token holds participants:email. Personal emails are never shared.

Errors

Status	code	Meaning
401	UNAUTHORIZED	Missing, invalid, or revoked token
403	FORBIDDEN	Token lacks participants:read
404	NOT_FOUND	Contract not found, or its job is not linked by this install

Request examples

curl

curl -sS https://app.opentrain.ai/api/partner/v1/contracts/<CONTRACT_ID>/participants \
  -H "Authorization: Bearer $OT_PARTNER_TOKEN"

Response examples

200

{
  "contractId": "<CONTRACT_ID>",
  "participants": [
    {
      "opentrainUserId": "<OPENTRAIN_USER_ID>",
      "displayName": "Maria S.",
      "country": "PH",
      "profileUrl": "https://app.opentrain.ai/profile/maria-s-annotation",
      "workEmail": "maria.1234@opentrain.work"
    }
  ]
}