• Register

Manage scheduled meetings

Endpoints

Get Scheduled Meeting

Get the details of a scheduled meeting by meeting ID.

Endpoint URL
/v1/meetings/{meetingId}
Method

GET

Parameters
Property Description Type Required?
meetingId The ID of the meeting to update integer Yes
Response

Return code: 200

Property Description Type
meetingStart The start time of the scheduled meeting datetime
(ISO 8601 format UTC time)
meetingName The name of the meeting string
meetingId The meeting ID of the scheduled meeting integer
meetingEnd The end time of the scheduled meeting datetime
(ISO 8601 format UTC time)
startWithPersonalUrl If true, the meeting will start with the user's personal URL. Otherwise, it will use a 9-digit code. boolean
participants E-mail addresses of the meeting participants string[]
conferenceId The 9-digit conference ID, needed to sign in to the teleconference string
viewerLink The URL that viewers can go to in order to launch the meeting
Important: This link does not become active until the start meeting API call is made for this meetingId.		 string
Example Request JSON
{}

Note: Include the meetingId 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/meetings/{meetingId}
Example Response
{
    "meetingId": {meetingId},
    "meetingName": "Weekly update with the boss",
    "meetingStart":"2015-06-02T09:00:00Z",
    "meetingEnd":"2015-06-02T10:00:00Z",
    "startWithPersonalUrl": true,
    "participants":["worldsbestboss@join.me","hardworker@join.me"],
    "conferenceId": "{9-digit conference ID}"
}

Get Scheduled Meetings

Returns an array that contains the meetings' properties.

Endpoint URL
/v1/meetings
Method

GET

Parameters
Property Description Type Required?
endDate If provided, returns meetings up until the given date only; otherwise returns all upcoming meetings datetime
(ISO 8601 format UTC time)		 No
Response

Return code: 200

Property Description
meetings

An array of scheduled meetings

Property Description Type
meetingStart The start time of the scheduled meeting datetime
(ISO 8601 format UTC time)
meetingName The name of the meeting string
meetingId The meeting ID of the scheduled meeting integer
meetingEnd The end time of the scheduled meeting datetime
(ISO 8601 format UTC time)
startWithPersonalUrl If true, the meeting will start with the user's personal URL. Otherwise, it will use a 9-digit code. boolean
viewerLink The URL that viewers can go to in order to launch the meeting
Important: This link does not become active until the start meeting API call is made for this meetingId.		 string
Example Request JSON
{}
Example cURL Request
curl -H "Authorization: Bearer {accesstoken}" -H "Content-Type: application/json" -X GET -d '{}' https://api.join.me/v1/meetings
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
        }
    ]
}

Schedule a New Meeting

Creates a new meeting and returns its properties.

Endpoint URL
/v1/meetings
Method

POST

Parameters
Property Description Type Required?
startWithPersonalUrl If true, the meeting starts using the user's personal URL boolean No
Defaults to false
meetingStart The time when the meeting should begin * datetime
(ISO 8601 format UTC time)		 Yes
meetingEnd The time when the meeting should end * Note: The end date must be within 14 days ofthe start date datetime
(ISO 8601 format UTC time)		 Yes
meetingName The name to use for the meeting string Yes
participants List of e-mails to invite to the meeting
Note: The user (presenter) is NOT included by default		 string[] No

* Note: The start date must precede the end date when scheduling a meeting.

Response

Return code: 201

Property Description Type
meetingId The meeting ID of the scheduled meeting integer
meetingName The name of the meeting string
meetingStart The start time of the scheduled meeting

datetime

(ISO 8601 format UTC time)
meetingEnd The end time of the scheduled meeting

datetime

(ISO 8601 format UTC time)
startWithPersonalUrl If true, the meeting will start with the user's personal URL. Otherwise, it will use a 9-digit code. boolean
participants E-mail addresses of the meeting participants string[]
viewerLink The URL that viewers can go to in order to launch the meeting
Important: This link does not become active until the start meeting API call is made for this meetingId.		 string

Example Request JSON

{
    "meetingStart":"2015-06-02T10:00:00Z",
    "meetingEnd":"2015-06-02T11:00:00Z",
    "meetingName":"Follow up with our customer",
    "startWithPersonalUrl": false,
    "participants":["youremail@join.me","the.best.customer@join.me"]
}
Example cURL Request
curl -H "Authorization: Bearer {accesstoken}" -H "Content-Type: application/json" -X POST -d '{"meetingStart":"2015-06-02T10:00:00Z", "meetingEnd":"2015-06-02T11:00:00Z", "meetingName":"Follow up with our customer", "participants":["youremail@join.me","the.best.customer@join.me"] }' https://api.join.me/v1/meetings

Example Response

{
    "meetingId": {meetingId},
    "meetingName": "Follow up with our customer",
    "meetingStart": "2015-06-02T10:00:00Z",
    "meetingEnd":"2015-06-02T11:00:00Z",
    "startWithPersonalUrl": false,
    "participants":["youremail@join.me","the.best.customer@join.me"]
}

Update a Meeting

Updates a meeting and returns the new meeting properties.

Endpoint URL
/v1/meetings/{meetingId}
Method

PATCH

Parameters
Property Description Type Required?
meetingId The ID of the meeting to update integer Yes
startWithPersonalUrl If true, update the meeting to start using the user's personal URL boolean No
defaults to false
meetingStart The time when the meeting should begin * datetime
(ISO 8601 format UTC time)		 No
meetingEnd The time when the meeting should end *
Notes: The end date must be within 14 days of the start date		 datetime
(ISO 8601 format UTC time)		 No
meetingName The name to use for the meeting string No
participants List of e-mails to invite to the meeting
Note: The user (presenter) is NOT included by default		 string[] No

* Note: The start date must precede the end date when updating a meeting, even if either the meetingStart or meetingEnd parameter is not provided.

Response

Return code: 201

Property Description Type
meetingId The meeting ID of the updated meeting integer
meetingName The name of the updated meeting string
meetingStart The start time of the updated meeting datetime
(ISO 8601 format UTC time)
meetingEnd The end time of the updated meeting datetime
(ISO 8601 format UTC time)
startWithPersonalUrl If true, the meeting will start with the user's personal URL. Otherwise, it will use a 9-digit code. boolean
participants List of e-mails to invite to the meeting
Note: This list will override the existing participants list; i.e. if you want to remove a participant, send the old list with the single participant removed.		 string[]
viewerLink The URL that viewers can go to in order to launch the meeting
Important: This link does not become active until the start meeting API call is made for this meetingId.		 string
Example Request JSON
{
    "meetingStart":"2015-06-03T10:00:00Z",
    "meetingEnd":"2015-06-03T11:00:00Z",
    "meetingName":"Follow up with our best customer",
    "startWithPersonalUrl": true,
    "participants":["youremail@join.me","the.best.customer@join.me","worldsbestboss@join.me"]
}

Note: Include the meetingId in the URL of the request

Example cURL Request
curl -H "Authorization: Bearer {accesstoken}" -H "Content-Type: application/json" -X PATCH -d '{ "meetingStart":"2015-06-03T10:00:00Z", "meetingEnd":"2015-06-03T11:00:00Z", "meetingName":"Follow up with our best customer", "participants":["youremail@join.me","the.best.customer@join.me","worldsbestboss@join.me"] }' https://api.join.me/v1/meetings/{meetingId}
Example Response
{
    "meetingId": {meetingId},
    "meetingName": "Follow up with our best customer",
    "meetingStart": "2015-06-32T10:00:00Z",
    "meetingEnd":"2015-06-03T11:00:00Z",             
    "startWithPersonalUrl": true,
    "participants":["youremail@join.me","the.best.customer@join.me","worldsbestboss@join.me"]
}

Delete a Meeting

Cancels an existing scheduled meeting.

Endpoint URL
/v1/meetings/{meetingId}
Method

DELETE

Parameters
Property Description Type Required?
meetingId The ID of the meeting to delete integer Yes
Response

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

Example Usage
{}

Note: Include the meetingId 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/meetings/{meetingId}
Example Response
{}

version 50 as of 9 years ago by joinme