• Register

Manage Presenters

Endpoints

Get Presenter

Get the details of a presenter by ID.

Endpoint URL
/v1/presenters/{presenterId}
Method

GET

Parameters
Property Description Type Required?
presenterId The ID of the presenter (include in URL). integer Yes
Response

Return code: 200

Property Description Type
id The presenter ID integer
email The presenter email string
isInvitationAccepted Indicates whether the presenter accepted the provisioning invitation Boolean
isSeatAssigned Indicates whether the presenter is currently occupying an available seat Boolean
Example Request JSON
{}

Note: Include the presenterId in the URL of the request

Example cURL Request
curl -H "Authorization: Bearer {accesstoken}" -H "Content-Type: application/json" -X GET -d '{}' https://api.join.me/v1/presenters/{presenterId}
Example Response
{
    "id": 000000000,
    "email": "hardworker@join.me",
    "isInvitationAccepted": false,
    "isSeatAssigned": false
}

Get All Presenters

Returns an array that contains all presenters for the Master Account Holder's account.

Endpoint URL
/v1/presenters
Method

GET

Parameters

None

Response

Return code: 200

An array containing presenter objects.

Example Request JSON
{}
Example cURL Request
curl -H "Authorization: Bearer {accesstoken}" -H "Content-Type: application/json" -X GET -d '{}' https://api.join.me/v1/presenters
Example Response
{
    "meetings": [
        {
            "meetingId": 12345,
            "meetingName": "Weekly update with the boss",
            "meetingStart":"2015-06-02T09:00:00Z",
            "meetingEnd":"2015-06-02T10:00:00Z",
            "startWithPersonalUrl": true
        },
        {
            "meetingId": 12399,
            "meetingName": "Follow up with our best customer",
            "meetingStart": "2015-06-02T10:00:00Z",
            "meetingEnd":"2015-06-02T11:00:00Z",
            "startWithPersonalUrl": false
        }
    ]
}

Add Presenter

Provisions a new presenter for the Master Account Holder.

Endpoint URL
/v1/presenters
Method

POST

Parameters
Property Description Type Required?
email The email of the user you want to invite. Note: This does not have to be a current join.me user's email. string Yes
Response

Return code: 200

presenterId

Example Request JSON

{
    "email": "newemployee@join.me"
}
Example cURL Request
curl -H "Authorization: Bearer {accesstoken}" -H "Content-Type: application/json" -X POST -d '{"email":"newemployee@join.me"}' https://api.join.me/v1/presenters

Example Response

000000000

Remove Presenter

Deprovisions a presenter from the Master Account Holder.

Endpoint URL
/v1/presenter/{presenterId}
Method

DELETE

Parameters
Property Description Type Required?
presenterId The ID of the presenter to remove (include in URL). integer Yes
Response

Return code: 204
The DELETE method has no return value.

Example Usage
None

Note: Include the presenterId in the URL of the request

Example cURL Request
curl -H "Authorization: Bearer {accesstoken}" -H "Content-Type: application/json" -X DELETE -d '{}' https://api.join.me/v1/presenters/{presenterId}
Example Response
None

Batch Remove Presenters

Deprovisions a pack of presenters from the Master Account Holder.

Endpoint URL
/v1/presenter/batch
Method

POST

Parameters
Property Description Type Required?
presenterIds The IDs of the presenters to remove. array of integers Yes
Response

Return code: 204

Example Request JSON

[
        "000000000",
        "000000000"
]
Example cURL Request
curl -H "Authorization: Bearer {accesstoken}" -H "Content-Type: application/json" -X POST -d '["000000000","000000000"]' https://api.join.me/v1/presenters/batch
Example Response
None

version 7 as of 7 years ago by joinme