Nested Party Model

Represents a reference to 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 organisation.

name String Read only

The name of the organisation. You cannot change the value of this field when updating or creating a person. This will contain Private when the user calling the API endpoint doesn't have access to the organisation record.

type String Read only

Represents if this party is a person or organisation.

Accepted values are: person, organisation

pictureURL String Read only

A URL that represents the location of the profile picture for this party.

isRestricted Boolean Read only

Defines whether this party is restricted for the user calling the API endpoint.