Speakap v1.8.2

Membership Resource

A membership is the role someone has in a specific group or network.

Changelog

1.0.10

  • Added invitedAt property.

1.0.12

  • Added role relation (for network memberships).

1.4.3

  • Added lockedBy property.

Representations

JSON

Properties

Name Type Description
EID EID Unique entity identifier
invitedAt datetime Since 1.0.10 Read-only Date the user was invited. This property may not be available for all memberships
lockedBy string Since 1.4.3 Read-only Hints the application that protects this membership from deletion
rev string network or group
role string Role: invitee, wannabee, member, admin or the EID of a user-defined role
since datetime Read-only Date since this membership became active

Example (group membership)

{
    "_links": {
        "self": {
            "href": "https://api.speakap.io/networks/FEDCBA0987654321/memberships/1234567890ABCDEF/"
        },
        "group": {
            "href": "https://api.speakap.io/networks/FEDCBA0987654321/groups/0123456789FEDCBA/"
        },
        "user": {
            "href": "https://api.speakap.io/networks/FEDCBA0987654321/users/ABCDEF0123456789/"
        }
    },
    "EID": "1234567890ABCDEF",
    "rev": "group",
    "role": "member",
    "since": "2013-04-11T13:35:07.123+01:00",
    "invitedAt": "2013-04-10T09:11:15.123+01:00"
}