Sign in

v1

latestOpenAPI 3.0.02026-07-24115101.2 MB
Contract - Parties and Participants

Get a participant by ID

Use this endpoint to retrieve a specific participant from a contract party by its ID.

get/contracts/{contract_id}/parties/{party_id}/participants/{participant_id}

Path parameters

contract_idinteger required

The unique ID of the contract.

party_idinteger required

The ID of a party in a contract.

participant_idinteger required

The ID of a participant in a contract.

Headers

x-oneflow-api-tokenstring required

The API key of your Oneflow account.

x-oneflow-user-emailstring email
Example:john.doe@oneflow.com

The email address of a registered Oneflow user.

Response

Returns the requested participant

delivery_channel'email' | 'sms' | 'email_and_sms' | 'same_device' | 'none' | 'unknown' required

One of the contract delivery channels.

delivery_status'not_sent' | 'pending' | 'failure' | 'bounce' | 'success' | 'opened' | 'unknown' required

One of the contract delivery status.

draft_approverboolean

A flag to indicate if the participant is a draft approver.

emailstring email required
idinteger required
identification_numberstring required
my_participantboolean required
namestring nullable required
organizerboolean required

A flag to indicate if the participant is an organizer combined with the permissions.

pending_approverboolean

A flag to indicate if the participant is a pending approver.

phone_numberstring nullable required
sign_method'standard_esign' | 'sms' | 'swedish_bankid' | 'norwegian_bankid' | 'danish_mitid' | 'finnish_bankid' | 'handwritten_signature' | 'eid_sign' | 'unknown' required

One of the sign methods.

sign_state'undecided' | 'signed' | 'declined' | 'unknown' required

One of the sign states.

sign_state_updated_timestring datetime nullable required
signatoryboolean required

A flag to indicate if the participant is an signatory combined with the permissions.

titlestring required
two_step_authentication_method'email' | 'sms' | 'personal_identification' | 'none' | 'unknown' required

One of the two step authentication methods.