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

Resource: Organization Members

The organization members resource describes the relationship between Lucid members and the organizations to which they belong. Each resource defines a typed association that includes the member's role in the specific organization.


Properties

#
Field Type Notes
organization_member_id integer
member_id integer
member_name plain text
organization_id tuple organization: {organization_id, name}
role_id tuple role: {role_id, name}
create_ts timestamp
update_ts timestamp

Listing Organization Members

# 
GET /lucid/api/v1/organizations/:organization_id/organization_members
Query parameter Notes
fields See Field Filtering
envelope See Enveloping

The Lucid Meetings API also provides subsets of organization members via the following collections. 

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

Sample Request

GET /lucid/api/v1/organizations/50030/organization_members?fields=organization_member_id,member_id

Content-Type: application/json; charset=utf-8 
Content-Length: 5313 
X-Requestor: jtkeith@lucidmeetings.com
X-Rate-Limit-Limit: 100
X-Rate-Limit-Remaining: 99
X-Rate-Limit-Used: 1
X-Rate-Limit-Reset: 60

[
  {
    "organization_member_id": 170,
    "member_id": 35
  },
  {
    "organization_member_id": 166,
    "member_id": 89
  },
  ... more data ...
]

Getting a Single Organization Member

# 
GET /lucid/api/v1/organization_members/:organization_member_id
Query parameter Notes
fields See Field Filtering
envelope See Enveloping

Sample Request

GET /lucid/api/v1/organization_members/170

Content-Type: application/json; charset=utf-8 
Content-Length: 396 
X-Requestor: jtkeith@lucidmeetings.com
X-Rate-Limit-Limit: 100
X-Rate-Limit-Remaining: 98
X-Rate-Limit-Used: 1
X-Rate-Limit-Reset: 51

{
  "organization_member_id": 170,
  "member_id": 35,
  "member_name": "Amy Farrell",
  "organization_id": {
    "value": 50030,
    "display": "Customer Projects"
  },
  "role_id": {
    "value": 5,
    "display": "Guest"
  },
  "create_ts": {
    "value": 1402359192,
    "iso_8601": "2014-06-10T00:13:12Z"
  },
  "update_ts": {
    "value": 1402359192,
    "iso_8601": "2014-06-10T00:13:12Z"
  }
}

Updating an Organization Member via PATCH

# 
PATCH /lucid/api/v1/organization_members/:organization_member_id
Field Required Notes
email no Member: The email address of the person
first_name no Member: The first name of this person
last_name no Member: The last name of this person
company no Member: The company this person represents
title no Member: The company or job title of this person
role_id no The role of this member in this specific organization

Sample Request

PATCH /lucid/api/v1/organizations/50030/members/150
Content-Type: application/json

{
  "first_name": "Robert",
  "last_name": "Smith",
  "role_id":3
}

200 OK
Content-Type: application/json

{
  "organization_member_id": 150,
  "member_id": 85,
  "member_name": "Robert Smith",
  "organization_id": {
    "value": 50030,
    "display": "Customer Projects"
  },
  "role_id": {
    "value": 3,
    "display": "Member"
  },
  "create_ts": {
    "value": 1398191495,
    "iso_8601": "2014-04-22T18:31:35Z"
  },
  "update_ts": {
    "value": 1461641987,
    "iso_8601": "2016-04-26T03:39:47Z"
  }
}

Creating a New Organization Member From a Site-Wide Member

#

This method for creating an organization member requires the API caller to have enterprise administrative permissions that allow access to the site-wide member listing. If you do not have this level of access, you may use the alternate method of creating a new organization member using their email address and other identifying information. 

POST /lucid/api/v1/organizations/:organization_id/organization_members

The Lucid Meetings API also provides the ability to POST directly to aliased sub-collections of organization members. This is mostly a convenience function that sets the organization member's role implicitly via the sub-collection purpose. 

POST /lucid/api/v1/organizations/:organization_id/administrators
POST /lucid/api/v1/organizations/:organization_id/members
POST /lucid/api/v1/organizations/:organization_id/guests
Field Required Notes
member_id yes The system-wide member_id for the person being added as an organization member.
role_id no The role of this member in this specific organization. If omitted, the organization member will be assigned a default GUEST organization role or a role based on the specific sub-collection.

Sample Request

POST /lucid/api/v1/organizations/50030/organization_members
Content-Type: application/json

{
  "member_id": 85,
  "role_id": 3
}

201 Created
Location: https://site.lucidmeetings.com/lucid/api/v1/organizations/50030/organization_members/150
Content-Type: application/json

{
  "organization_member_id": 150,
  "member_id": 85,
  "member_name": "Robert Smith",
  "organization_id": {
    "value": 50030,
    "display": "Customer Projects"
  },
  "role_id": {
    "value": 3,
    "display": "Member"
  },
  "create_ts": {
    "value": 1398191495,
    "iso_8601": "2014-04-22T18:31:35Z"
  },
  "update_ts": {
    "value": 1461351062,
    "iso_8601": "2016-04-22T18:51:02Z"
  }
}

Creating a New Organization Member From an Email Address

#

Organization members may also be created based on their email address. This will either use or create a system-wide member organization for the person, then add them to the organization with the specified role. 

POST /lucid/api/v1/organizations/:organization_id/organization_members

The Lucid Meetings API also provides the ability to POST directly to aliased sub-collections of organization members. This is mostly a convenience function that sets the organization member's role implicitly via the sub-collection purpose. 

POST /lucid/api/v1/organizations/:organization_id/administrators
POST /lucid/api/v1/organizations/:organization_id/members
POST /lucid/api/v1/organizations/:organization_id/guests
Field Required Notes
email yes Member: The email address of the person to either find or create
first_name no Member: The first name of this new person
last_name no Member: The last name of this new person
company no Member: The company this new person represents
title no Member: The company or job title of this new person
role_id no The role of this member in this specific organization. If omitted, the organization member will be assigned a default GUEST organization role or a role based on the specific sub-collection.

Sample Request

POST /lucid/api/v1/organizations/50030/organization_members
Content-Type: application/json

{
  "email": "bobsmith@example.com",
  "first_name": "Bob",
  "last_name": "Smith",
  "role_id": 3
}

201 Created
Location: https://site.lucidmeetings.com/lucid/api/v1/organizations/50030/organization_members/304
Content-Type: application/json

{
  "organization_member_id": 304,
  "member_id": 209,
  "member_name": "Bob Smith",
  "organization_id": {
    "value": 50030,
    "display": "Customer Projects"
  },
  "role_id": {
    "value": 3,
    "display": "Member"
  },
  "create_ts": {
    "value": 1461354623,
    "iso_8601": "2016-04-22T19:50:23Z"
  },
  "update_ts": {
    "value": 1461354623,
    "iso_8601": "2016-04-22T19:50:23Z"
  }
}

Deleting an Organization Member

# 
DELETE /lucid/api/v1/organization_members/:organization_member_id

Sample Request

DELETE /lucid/api/v1/organizations/50030/organization_members/169




204 No Content