/
Participants
Participants
- Jeremy Bruce (Unlicensed)
- Steve Randall
- Terra Yi (Unlicensed)
Owned by Jeremy Bruce (Unlicensed)
The information in this document is currently in BETA and subject to change.
The Participants resource is one the central resources in the Actionstep system. Many other resources reference it and there are a large number of resources that extend this base resource. Participants server as the base contact record for general Contacts, Action Participants, System Users and Divisions.
Resource Properties
| Scope Parameter | participants |
|---|---|
| Location | /participants |
| Methods | GET POST PUT |
| Default Page Size | 50 |
| Max Page Size | 200 |
| Default Includes | None |
Resource Atributes
| Field | Description | Format | Required | Field Type | Notes |
|---|---|---|---|---|---|
| displayName | The participants name formatted as defined by the Display Name Format global preference. | string | false | default | Read-only field. Returned in GET requests. |
| isCompany | Defines the participant as either a Company or Individual. | boolean | true | default | |
| companyName | The name of the company if the participant is a Company, or the name of the employer if the participant is an Individual. | string | false | default | |
| salutation | The Individual's prefix. | string | false | default | |
| firstName | The Individual's first name. | string | * | default | If isCompany === false then this field is required. |
| middleName | The Individual's middle name. | string | false | default | |
| lastName | The Individual's last name. | string | * | default | If isCompany === false then this field is required. |
| suffix | The Individual's suffix. | string | false | default | |
| preferredName | The Individual's preferred name. | string | false | additional | |
| physicalAddressLine1 | The primary field for the physical address of the participant. | string | false | default | |
| physicalAddressLine2 | An optional secondary address field for the physical address. | string | false | default | |
| physicalCity | The city portion of the physical address. | string | false | default | |
| physicalStateProvince | The state or province portion of the physical address. | string | false | default | |
| physicalPostCode | The postcode or zip code portion of the physical address. | string | false | default | |
| mailingAddressLine1 | The primary field for the mailing address of the participant. | string | false | additional | |
| mailingAddressLine2 | An optional secondary address field for the mailing address. | string | false | additional | |
| mailingCity | The city portion of the mailing address. | string | false | additional | |
| mailingStateProvince | The state or province portion of the mailing address. | string | false | additional | |
| mailingPostCode | The postcode or zip code portion of the mailing address. | string | false | additional | |
| phone1Label | A description of the primary phone number. | string | false | default | |
| phone1Country | The country portion of the primary phone number. | integer | false | default | |
| phone1Area | The area code portion of the primary phone number. | integer | false | default | |
| phone1Number | The number portion of the primary phone number. | string | false | default | |
| phone1Notes | A notes field for the primary phone number. | string | false | default | |
| phone2Label | A description of the secondary phone number. | string | false | additional | |
| phone2Country | The country portion of the secondary phone number. | integer | false | additional | |
| phone2Area | The area code portion of the secondary phone number. | integer | false | additional | |
| phone2Number | The number portion of the secondary phone number. | string | false | additional | |
| phone2Notes | A notes field for the secondary phone number. | string | false | additional | |
| phone3Label | A description of the tertiary phone number. | string | false | additional | |
| phone3Country | The country portion of the tertiary phone number. | integer | false | additional | |
| phone3Area | The area code portion of the tertiary phone number. | integer | false | additional | |
| phone3Number | The number portion of the tertiary phone number. | string | false | additional | |
| phone3Notes | A notes field for the tertiary phone number. | string | false | additional | |
| phone4Label | A description of the quaternary phone number. | string | false | additional | |
| phone4Country | The country portion of the quaternary phone number. | integer | false | additional | |
| phone4Area | The area code portion of the quaternary phone number. | integer | false | additional | |
| phone4Number | The number portion of the quaternary phone number. | string | false | additional | |
| phone4Notes | A notes field for the quaternary phone number. | string | false | additional | |
| fax | The participant's fax number. | string | false | additional | |
| sms | The number to use for SMS. | string | false | additional | |
| The participant's email address. | string | false | default | ||
| website | The participant's web address. | string | false | additional | |
| occupation | The participant's occupation. | string | false | additional | |
| taxNumber | The tax number for the Company or Individual. Uses the Tax Number Alias on the Base Participant Type to determine what type of tax this is. | string | false | additional | |
| birthTimestamp | The Individual's Date of Birth. | date | false | default | |
| deathTimestamp | The Individual's Date of Death. | date | false | additional | |
| maritalStatus | The marital status of the Individual. | string | false | default | |
| gender | The gender of the Individual. | string | true | default | |
| modifiedTimestamp | Timestamp when the record was last modified. | timestamp | false | additional | |
| createdTimestamp | Timestamp when the record was created. | timestamp | false | additional | |
| baseParticipantType | The base Participant Type for this resource. | string | true | link | May only have one base type. Not yet implemented |
| physicalCountry | The associated Countries resource for the country portion of the physical address. | string | false | link | |
| mailingCountry | The associated Countries resource for the country portion of the mailing address. | string | false | link | |
| division | The associated Divisions resource for the participant. | string | true | link | |
| billingPreference | The associated Billingpreference resource of the participant. | string | false | link | Not Yet Implemented |
| amlStatus | The status for the AML check for this participant. | string | false | string | Must be one of 'Not started', 'In progress', 'Signed off'. |
| amlProgress | The percentage of the AML process completed. | integer | false | integer | 0 to 100. |
| amlRisk | The AML risk level assigned to this participant. | string | false | string | Must be one of 'Unknown', 'Low', 'Medium', 'High'. |
| amlNote | Some AML notes. | string | false | string |
Link Templates
| Identifier | Resource | Location Template |
|---|---|---|
| participants.physicalCountry | countries | /countries/{participants.physicalCountry} |
| participants.mailingCountry | countries | /countries/{participants.mailingCountry} |
| participants.division | divisions | /divisions/{participants.division} |
| participants.billingPreference | billingPreferences | /billingPreferences/{participants.billingPreference} |
Related content
Action Create
Action Create
Read with this
Participant Types
Participant Types
More like this
Data Collection Fields
Data Collection Fields
Read with this
Custom Participant Data
Custom Participant Data
More like this
Data Collections
Data Collections
Read with this
Action Participants
Action Participants
More like this