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

Resource: Members

The members resource contains all information about a specific member in the system. Members have contextual relationships to organizations (as organization administrators, members, or guests), rooms (as room managers, members, or guests), and meetings (as facilitators, participants, or guests).


Properties

#
Field Type Notes
member_id integer
first_name plain text (64) The first name of this person
last_name plain text (64) The last name of this person
company plain text (64) The company this person represents
title plain text (32) The company or job title of this person
email email address The email address of this person
password plain text The password for this person. N.B., WRITE-ONLY.
last_access timestamp
create_ts timestamp
update_ts timestamp

Listing Members

#

This method requires the API caller to have enterprise administrative permissions that allow access to the site-wide member listing. Note that any authorized API caller can always access their own member record.

GET /lucid/api/v1/members (must be logged in)
Query parameter Notes
me One of: true or false to restrict the list to my information only
search plain text
page Page number, starting from 0
per_page Any integer between 0 and 100, inclusive
sort

Default: -access

One of name , -name , company , -company , created , -created , access , -access , email , -email .
embed Comma separated list of embeddables: organizations , rooms , meetings ,
fields See Field Filtering
envelope See Enveloping

Sample Request

GET /lucid/api/v1/members?fields=member_id,first_name,last_name&per_page=3&page=1
Content-Type: application/json; charset=utf-8 
Content-Length: 246 
X-Requestor: jtkeith@lucidmeetings.com
X-Rate-Limit-Limit: 100
X-Rate-Limit-Remaining: 96
X-Rate-Limit-Used: 1
X-Rate-Limit-Reset: 15
X-Total-Count: 86
X-Total-Pages: 29
X-Page-Num: 1
X-Per-Page: 3
Link: <https://site.lucidmeetings.com/lucid/api/v1/members?fields=member_id%2Cfirst_name%2Clast_name&per_page=3&page=0&envelope=&embed=&search=&sort=-access&z=>; rel="prev",
      <https://site.lucidmeetings.com/lucid/api/v1/members?fields=member_id%2Cfirst_name%2Clast_name&per_page=3&page=2&envelope=&embed=&search=&sort=-access&z=%gt;; rel="next" 
[
  {
    "member_id": 75,
    "first_name": "Sally",
    "last_name": "Johnson"
  },
  {
    "member_id": 5,
    "first_name": "Tony",
    "last_name": "Curwen"
  },
  {
    "member_id": 40,
    "first_name": "Maggie",
    "last_name": "West"
  }
]

Getting a Single Member

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

Sample Request

GET /lucid/api/v1/members/75?fields=first_name,last_name,last_access
Content-Type: application/json; charset=utf-8 
Content-Length: 135 
X-Requestor: jtkeith@lucidmeetings.com
X-Rate-Limit-Limit: 100
X-Rate-Limit-Remaining: 98
X-Rate-Limit-Used: 1
X-Rate-Limit-Reset: 9
{
  "first_name": "Sally",
  "last_name": "Johnson",
  "last_access": {
    "ts": 1438298176,
    "iso_8601": "2015-07-30T23:16:16Z"
  }
}

Updating a Member via PATCH

#
PATCH /lucid/api/v1/members/:member_id
Field Required Notes
email no The email address of the person
password no The password for the person
first_name no The first name of this person
last_name no The last name of this person
company no The company this person represents
title no The company or job title of this person

Sample Request

PATCH /lucid/api/v1/members/210
Content-Type: application/json
{
  "first_name": "Foster",
  "last_name": "Pearson",
  "company": "Princess Lines"
}
200 OK
Content-Type: application/json
{
  "member_id": 210,
  "first_name": "Foster",
  "last_name": "Pearson",
  "company": "Princess Lines",
  "title": "Director",
  "email": "foster.pearson@example.com",
  "last_access": null,
  "create_ts": {
    "value": 1461728532,
    "iso_8601": "2016-04-27T03:42:12Z"
  },
  "update_ts": {
    "value": 1461730366,
    "iso_8601": "2016-04-27T04:12:46Z"
  }
}

Creating a New Member

#
POST /lucid/api/v1/members
Field Required Notes
email yes The email address of the person to create
password no The password for the person
first_name no The first name of this new person
last_name no The last name of this new person
company no The company this new person represents
title no The company or job title of this new person

Sample Request

POST /lucid/api/v1/member
Content-Type: application/json
{
    "first_name": "Foster",
    "last_name": "Pearson",
    "title": "Director",
    "email": "foster.pearson@example.com"
}
201 Created
Location: https://site.lucidmeetings.com/lucid/api/v1/members/210
Content-Type: application/json
{
  "member_id": 210,
  "first_name": "Foster",
  "last_name": "Pearson",
  "company": "",
  "title": "Director",
  "email": "foster.pearson@example.com",
  "last_access": null,
  "create_ts": {
    "value": 1461728532,
    "iso_8601": "2016-04-27T03:42:12Z"
  },
  "update_ts": {
    "value": 1461728532,
    "iso_8601": "2016-04-27T03:42:12Z"
  }
}

Deleting a Member

#

This method requires the API caller to have enterprise administrative permissions that allow access to the site-wide member listing. Note that any authorized API caller can always access their own member record.

DELETE /lucid/api/v1/members/:member_id

Sample Request

DELETE /lucid/api/v1/members/206


204 No Content