Represents the Organization itself.
NoteAll Organization properties requiring Public access are exposed through
GET
to the public.
_id String | The org identifier |
access | The current caller’s context access level. |
apps | The Org’s configured applications. |
code* | The Org’s code, used to access the api, uniquely identifies the org. |
configuration | Org configuration settings. |
connections | Connections associated with the Org. |
created | The date the context was created. |
deployment | Org deployment settings |
favicon | Organization Icon |
locale | The Org’s default locale setting. |
logo | The Org logo. |
maintenance | True if Org is in maintenance mode. |
maintenanceMessage | The message to show during maintenance mode. |
name* | The Org label. |
object | The context’s object name. |
posts | A list of posts made in the context of the org. |
registration | Org registration settings. |
roles | Org’s configured roles. |
schemasETag | Org schemas ETag |
security | Org security settings. |
shared | True if there are any active or pending connections for this context. |
state | The Org state. |
support | Support options. |
tz | Default timezone for the org. This helps determine UTC offset when working in scripts when a user tz is not available. The timezone must by a unique identifier for an IANA assigned zone, e.g. "US/Pacific" |
updated | The date the latest update was made to a context’s properties |
updater | The account id of the context updater |
website | The Org website, available for use as a variable in email templates (org.website). |
{
"_id": "5516ee1b34d8d934281699e3",
"access": 1,
"code": "example",
"favicon": {
"ETag": "31074002db56d2d6fc8fee5b05caee1c",
"creator": "5516ee2634d8d93428169c0e",
"location": 4,
"mime": "image/x-icon",
"name": "content",
"path": "/orgs/5516ee1b34d8d934281699e3/favicon/content",
"size": 15086,
"state": 2
},
"locale": "en_US",
"logo": {
"ETag": "594b69d035ac27c2e69ef053082eb6a3",
"creator": "5516ee2634d8d93428169c0e",
"facets": [
{
"ETag": "5046104d05edf82e2a2c0d72118ca15b",
"creator": "5516ee2634d8d93428169c0e",
"height": 241,
"location": 4,
"mime": "image/jpeg",
"name": "thumbnail",
"path": "/orgs/5516ee1b34d8d934281699e3/logo/thumbnail",
"size": 16495,
"state": 2,
"width": 300
}
],
"height": 500,
"location": 4,
"mime": "image/jpeg",
"name": "content",
"path": "/orgs/5516ee1b34d8d934281699e3/logo/content",
"size": 52586,
"state": 2,
"width": 622
},
"name": "Example",
"object": "org",
"schemasETag": "b7fa703927702d09ada85150f475d88c"
}