2.1.1 Organization object
Represents an organization. Inherits from the 2.1.1 Actor object.
Example
{
"type": "ORGANIZATION",
"id": "nPjYUn0upc8dIm7yzTIBgQ",
"name": "Acme Corp",
"emailAddress": "info@acme.example.com",
"locale": "en_US",
"contract": {
"id": "business-trial",
"type": "BUSINESS"
}
}
Fields
Field | Type | Description |
---|---|---|
type required |
String constant | The actor type; always ORGANIZATION . Inherited from Actor. |
id required |
String | The unique ID for this organization. Inherited from Actor. |
name required |
String | The organization's name. Inherited from Actor. |
avatar optional |
2.1.1 Media object | An optional avatar to represent the actor. Inherited from Actor. |
emailAddress optional |
String | The primary email address of the actor. Inherited from Actor. Example value: info@acme.example.com |
locale optional |
String | An optional locale code for this actor. This may be a language code only, or a combination of language and country codes. Inherited from Actor. Example value: en or en_US |
domicile optional |
String | An optional country code that reflects the domicile of this actor. This should be an upper case ISO 3166-1 country code. Inherited from Actor. Example value: US or FR |
contract optional |
2.1.1 Contract object | Details of the contract for the organization. |
groupMemberQuota optional |
Integer | An optional limit to the total number of group members that this organization may have. Example value: 150 |
thirdParties optional |
List of strings | An optional list of third parties that this organization supports. |
mayCreateGroupMemberAccounts optional |
Boolean | Indicates whether this organization is permitted to set up group member accounts. |
license optional |
2.1.1 License object | An optional license that may apply to the organiation's drills. |
privacyLocation optional |
String | Represents an optional physical restriction on the storage of privacy related data. |
catalogs optional |
List of 2.1.1 Catalog object | An optional list of catalogs that the organization may publish to. |
registeredAddress optional |
String | The organization's registered address. Only applicable to business and educational organizations. |
vatNumber optional |
String | The organization's VAT number. |
Last updated on