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

Resource: Metadata

The metadata resource describes information about other resources in the Lucid Meetings service, including: organizations, rooms, and meetings.

Field Type Notes
organization_roles array of tuples {id, name}
room_roles array of tuples {id, name}
meeting_roles array of tuples {id, name}
meeting_rsvps array of tuples {id, name}
action_item_states array of tuples {id, name}
rest_hook_events array of tuples {event, description}

Listing Metadata

#
GET /lucid/api/v1/metadata (must be logged in)
Query parameter Notes
fields See Field Filtering
envelope See Enveloping

Sample Request for Meeting Roles

#

Use the fields query parameter to limit the result.

GET /lucid/api/v1/metadata?fields=meeting_roles
Content-Type: application/json; charset=utf-8 
Content-Length: 282 
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
[
  {
    "id": 2,
    "display": "Facilitator"
  },
  {
    "id": 3,
    "display": "Participant"
  },
  {
    "id": 4,
    "display": "Observer"
  },
  {
    "id": 5,
    "display": "Guest"
  }
]

Sample Data for Organization Roles

#
GET lucid/api/v1/metadata?fields=organization_roles
[
  {
    "id": 1,
    "display": "Owner"
  },
  {
    "id": 2,
    "display": "Administrator"
  },
  {
    "id": 3,
    "display": "Member"
  },
  {
    "id": 4,
    "display": "Executive"
  },
  {
    "id": 5,
    "display": "Guest"
  }
]

Sample Data for Room Roles

#
GET lucid/api/v1/metadata?fields=room_roles
[
  {
    "id": 2,
    "display": "Manager"
  },
  {
    "id": 3,
    "display": "Member"
  },
  {
    "id": 4,
    "display": "Observer"
  },
  {
    "id": 5,
    "display": "Guest"
  }
]

Sample Data for Meeting RSVPs

#
GET lucid/api/v1/metadata?fields=meeting_rsvps
[
  {
    "id": 0,
    "display": "None Yet"
  },
  {
    "id": 1,
    "display": "Yes"
  },
  {
    "id": 2,
    "display": "No"
  },
  {
    "id": 3,
    "display": "Maybe"
  }
]

Sample Data for Action Item States

#
GET lucid/api/v1/metadata?fields=action_item_states
[
  {
    "id": 0,
    "display": "Open"
  },
  {
    "id": 1,
    "display": "Closed"
  }
]

Sample Data for REST Hook Events

#

Most REST hook events can be scoped at either an organization or room level (there are legitimate use-cases for both scoping levels). If an event hook includes a room_id field, then the callback occurs for the named event in that room only. If the room_id field is omitted, but an organization_id field is included, then the callback occurs for the named event for all rooms in the organization.

GET /lucid/api/v1/metadata?fields=rest_hook_events
[
  {
    "id": "action_item_created",
    "display": "Action item created",
    "room_event": true,
    "organization_event": true
  },
  {
    "id": "action_item_assigned",
    "display": "Action item assigned",
    "room_event": true,
    "organization_event": true
  },
  {
    "id": "meeting_created",
    "display": "Meeting created",
    "room_event": true,
    "organization_event": true
  },
  {
    "id": "meeting_scheduled",
    "display": "Meeting scheduled",
    "room_event": true,
    "organization_event": true
  },
  {
    "id": "meeting_started",
    "display": "Meeting session started",
    "room_event": true,
    "organization_event": true
  },
  {
    "id": "meeting_ended",
    "display": "Meeting session ended",
    "room_event": true,
    "organization_event": true
  },
  {
    "id": "followup_sent",
    "display": "Followup email sent to attendees",
    "room_event": true,
    "organization_event": true
  },
  {
    "id": "invitation_sent",
    "display": "Invitation email sent to attendees",
    "room_event": true,
    "organization_event": true
  }
]