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.
Resource Location: /participants
Available Methods: GET POST PUT DELETE OPTIONS
Default Page Size: 50
Max Page Size: 100
Default Includes: None
Resource Atributes
| Field | Description | Format | Required | Field Type | Notes |
|---|---|---|---|---|---|
| displayName | string | true | default | ||
| isCompany | boolean | true | default | ||
| companyName | string | false | default | ||
| salutation | string | false | default | ||
| firstName | string | false | default | ||
| middleName | string | false | default | ||
| lastName | string | false | default | ||
| suffix | string | false | default | ||
| preferredName | string | false | additional | ||
| physicalAddressLine1 | string | false | default | ||
| physicalAddressLine2 | string | false | default | ||
| physicalCity | string | false | default | ||
| physicalStateProvince | string | false | default | ||
| physicalPostCode | string | false | default | ||
| physicalCountry | string | false | link | ||
| mailingAddressLine1 | string | false | additional | ||
| mailingAddressLine2 | string | false | additional | ||
| mailingCity | string | false | additional | ||
| mailingStateProvince | string | false | additional | ||
| mailingPostCode | string | false | additional | ||
| mailingCountry | string | false | link | ||
| phone1Label | string | false | default | ||
| phone1Country | string | false | default | ||
| phone1Area | string | false | default | ||
| phone1Number | string | false | default | ||
| phone1Notes | string | false | default | ||
| phone2Label | string | false | additional | ||
| phone2Country | string | false | additional | ||
| phone2Area | string | false | additional | ||
| phone2Number | string | false | additional | ||
| phone2Notes | string | false | additional | ||
| phone3Label | string | false | additional | ||
| phone3Country | string | false | additional | ||
| phone3Area | string | false | additional | ||
| phone3Number | string | false | additional | ||
| phone3Notes | string | false | additional | ||
| phone4Label | string | false | additional | ||
| phone4Country | string | false | additional | ||
| phone4Area | string | false | additional | ||
| phone4Number | string | false | additional | ||
| phone4Notes | string | false | additional | ||
| fax | string | false | additional | ||
| sms | string | false | additional | ||
| string | false | default | |||
| website | string | false | additional | ||
| occupation | string | false | additional | ||
| taxNumber | string | false | additional | ||
| birthTimestamp | timestamp | false | default | ||
| deathTimestamp | timestamp | false | additional | ||
| maritalStatus | string | false | default | ||
| gender | string | true | default | ||
| emailFormat | string | false | additional | ||
| notificationMethod | string | false | additional | ||
| isNewsletterSubscriber | boolean | false | additional | ||
| modifiedTimestamp | timestamp | false | additional | ||
| createdTimestamp | timestamp | false | additional | ||
| division | string | true | link | ||
| billingPreference | string | false | link |
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} |
Example Requests / Responses
- GET timerecords
- POST timerecords
- PUT timerecords
- DELETE timerecords