Organization
Represents the Organization itself
All Organization properties requiring Public access are exposed through GET to the public.
Organization Object Data Model
name | data type | description |
| String | The org identifier |
| Number | The current caller’s context access level. |
| Document | The Org’s configured applications. |
| String | The Org’s code, used to access the api, uniquely identifies the org. |
| String | Org configuration settings. |
| Reference | Connections associated with the Org. |
| Date | The date the context was created |
| Document | Org deployment settings |
| File | Organization Icon |
| String | The Org’s default locale setting. |
| File | The Org logo. |
| Boolean | True if Org is in maintenance mode. |
| String | The message to show during maintenance mode. |
| String | The Org label. |
| String | The context’s object name. |
| Reference | A list of posts made in the context of the org. |
| Document | Org registration settings. |
| Document | Org’s configured roles |
| String | Org schemas ETag |
| Document | Org security settings |
| Boolean | True if there are any active or pending connections for this context. |
| String | The Org state. |
| Document | Support options. |
| 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" |
| Date | The date the latest update was made to a context’s properties |
| Reference | The account id of the context updater |
| String | The Org website, available for use as a variable in email templates (org.website). |
Example Organization Object
Read (Public)
GET
https://api.dev.medable.com/{your_org_name}/v2
Path Parameters
Name | Type | Description |
---|---|---|
your_org_name | string | {org_name} |
--
Read (Full)
GET
https://api.dev.medable.com/{your_org_name}/v2/orgs/org_id
Path Parameters
Name | Type | Description |
---|---|---|
your_org_name | string | {org_name} |
org_id | string | {org_id} |
Update
PUT
https://api.dev.medable.com/{your_org_name}/v2
The Organization settings can only be updated by an Administrator. Because the Org is public, it is possible to add a custom property to allow those with other roles (or no roles) to update it. To demonstrate, the following property has been added to the Organization in the example request to the right, and all Providers given access to push elements onto the c_4providers array.
Path Parameters
Name | Type | Description |
---|---|---|
your_org_name | string | {org_name} |
org_id | string | {org_id} |
Update
PATCH
https://api.dev.medable.com/{your_org_name}/v2
Path Parameters
Name | Type | Description |
---|---|---|
your_org_name | string | {org_name} |
org_id | string | {org_id} |
Request Body
Name | Type | Description |
---|---|---|
op | string | op |
path | string | path |
value | string | value |
Last updated