Please see the full REST API documentation for API implementation details.

Resource: Organizations

An organization is a top-level organizing structure that contains meeting rooms, in which meetings are scheduled and held. Organizations also contain organization members who may be added to specific meeting rooms.


Properties

#
Field Type Notes
name plain text (255)
organization_id integer
organization_url url The network location of the UI for this organization
member_id tuple owner: {member_id, name}
create_ts timestamp
update_ts timestamp

Getting a List of My Organizations

#
GET /lucid/api/v1/organizations (must be logged in)
Query parameter Notes
manager One of: true or false
zapier One of: true or false
embed Comma separated list of embeddables: rooms , organization_members , administrators , members , guests
fields See Field Filtering
envelope See Enveloping

Sample Request

GET /lucid/api/v1/organizations?manager=true&fields=organization_id,name
Content-Type: application/json; charset=utf-8 
Content-Length: 288 
X-Requestor: jtkeith@lucidmeetings.com
X-Rate-Limit-Limit: 100
X-Rate-Limit-Remaining: 98
X-Rate-Limit-Used: 1
X-Rate-Limit-Reset: 44
[
  {
    "name": "Customer Projects",
    "organization_id": 50030
  },
  {
    "name": "Marketing",
    "organization_id": 50080
  },
  {
    "name": "Human Resources",
    "organization_id": 50059
  },
  {
    "name": "Sales",
    "organization_id": 50078
  }
]

Getting a Single Organization

#
GET /lucid/api/v1/organizations/:organization_id
Query parameter Notes
embed Comma separated list of embeddables: rooms , organization_members , administrators , members , guests
fields See Field Filtering
envelope See Enveloping

Sample Request

GET /lucid/api/v1/organizations/50030
Content-Type: application/json; charset=utf-8 
Content-Length: 307 
X-Requestor: jtkeith@lucidmeetings.com
X-Rate-Limit-Limit: 100
X-Rate-Limit-Remaining: 98
X-Rate-Limit-Used: 2
X-Rate-Limit-Reset: 60
{
  "organization_id": 50030,
  "name": "Customer Projects",
  "member_id": {
    "value": 1,
    "display": "Bob Smith"
  },
  "create_ts": {
    "value": 1387166101,
    "iso_8601": "2013-12-16T03:55:01Z"
  },
  "update_ts": {
    "value": 1438224720,
    "iso_8601": "2015-07-30T02:52:00Z"
  }
}

Updating an Organization via PATCH

#
PATCH /lucid/api/v1/organizations/:organization_id
Field Required Notes
name no Must not be an empty value
member_id no The member_id of the organization's new owner. Must already be an active organization member.

Sample Request

PATCH /lucid/api/v1/organizations/50030
Content-Type: application/json
{
  "name": "Customer Projects",
  "member_id": 60
}
200 OK
Content-Type: application/json
{
  "organization_id": 50030,
  "name": "Customer Projects",
  "member_id": {
    "value": 60,
    "display": "Fred Keith"
  },
  "create_ts": {
    "value": 1387166101,
    "iso_8601": "2013-12-16T03:55:01Z"
  },
  "update_ts": {
    "value": 1462234736,
    "iso_8601": "2016-05-03T00:18:56Z"
  }
}

Creating an Organization

#

This method requires the API caller to have enterprise administrative permissions that allow access to the site-wide organization listing. For nearly all cases the required organization type will be enterprise .

POST /lucid/api/v1/organizations
Field Required Notes
name yes Must not be an empty value
type yes One of: enterprise , free-subscription , flex-subscription
member_id yes The member_id of the new organization's owner.

Sample Request

POST /lucid/api/v1/organizations
Content-Type: application/json
{
  "name":"Acme Sales",
  "type":"enterprise",
  "member_id":105
}
201 Created
Location: https://site.lucidmeetings.com/lucid/api/v1/organizations/50093
Content-Type: application/json
{
  "organization_id": 50093,
  "name": "Acme Sales",
  "member_id": {
    "value": 105,
    "display": "Jack Bronson"
  },
  "create_ts": {
    "value": 1462330315,
    "iso_8601": "2016-05-04T02:51:55Z"
  },
  "update_ts": {
    "value": 1462330315,
    "iso_8601": "2016-05-04T02:51:55Z"
  }
}

Deleting an Organization

#

This method requires the API caller to be the organization owner, or to have enterprise administrative permissions that allow access to the site-wide organization listing.

DELETE /lucid/api/v1/organizations/:organization_id

Sample Request

DELETE /lucid/api/v1/organizations/50092


204 No Content


#

An individual organization resource contains a set of collections that are managed in context: organization_members and rooms .

Organization Members

Please see the organization members resource for more information.

GET /lucid/api/v1/organizations/:organization_id/organization_members
GET /lucid/api/v1/organizations/:organization_id/organization_members/:organization_member_id

The Lucid Meetings API provides collection shortcuts for interacting with subsets of the organization members: owners , administrators , members , and guests .

GET /lucid/api/v1/organizations/:organization_id/owners
GET /lucid/api/v1/organizations/:organization_id/owners/:organization_member_id
GET /lucid/api/v1/organizations/:organization_id/administrators
GET /lucid/api/v1/organizations/:organization_id/administrators/:organization_member_id
GET /lucid/api/v1/organizations/:organization_id/members
GET /lucid/api/v1/organizations/:organization_id/members/:organization_member_id
GET /lucid/api/v1/organizations/:organization_id/guests
GET /lucid/api/v1/organizations/:organization_id/guests/:organization_member_id

Rooms

Please see the rooms resource for more information.

GET /lucid/api/v1/organizations/:organization_id/rooms
GET /lucid/api/v1/organizations/:organization_id/rooms/:room_id

Action Items

Please see the action items resource for more information.

GET /lucid/api/v1/organizations/:organization_id/action_items
GET /lucid/api/v1/organizations/:organization_id/action_items/:action_item_id