Organization Object

Represents the Organization itself.

📘

Note

All Organization properties requiring Public access are exposed through GET to the public.

_id String	The org identifier
access Number	The current caller’s context access level.
apps Document[]	The Org’s configured applications.
code* String	The Org’s code, used to access the api, uniquely identifies the org.
configuration Document	Org configuration settings.
connections Reference[]	Connections associated with the Org.
created Date	The date the context was created.
deployment Document	Org deployment settings
favicon File	Organization Icon
locale String	The Org’s default locale setting.
logo File	The Org logo.
maintenance Boolean	True if Org is in maintenance mode.
maintenanceMessage String	The message to show during maintenance mode.
name* String	The Org label.
object String	The context’s object name.
posts Reference[]	A list of posts made in the context of the org.
registration Document	Org registration settings.
roles Document[]	Org’s configured roles.
schemasETag String	Org schemas ETag
security Document	Org security settings.
shared Boolean	True if there are any active or pending connections for this context.
state String	The Org state.
support Document	Support options.
tz String	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 Date	The date the latest update was made to a context’s properties
updater Reference	The account id of the context updater
website String	The Org website, available for use as a variable in email templates (org.website).

Example Organization Object

{
    "_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"
}