Represents a reference to a party. By default, contains only the id, name and pictureURL.
If the field is included in the embed
parameter will instead be a full
Party object. If the party is restricted for the user calling the API
endpoint, the full Party object is not included.
Name | Type | Description | |
---|---|---|---|
id | Long | Read only |
The unique id of the party. |
firstName | String | Read only |
The first name of the person. This field is present only when |
lastName | String | Read only |
The last name of the person. This field is present only when |
name | String | Read only |
The name of the organisation. This field is present only when |
type | String | Read only |
Determines whether this party is a person or an organisation. Accepted values are: |
pictureURL | String | Read only |
A URL that represents the location of the profile picture for this party. |
isRestricted | Boolean | Read only |
Indicates whether this party is restricted for the user calling the API endpoint. |