• Register

Users

Endpoints

Get User Information

Returns information on the join.me user corresponding to the OAuth 2.0 access token.

Endpoint URL
https://api.join.me/v1/user
Method

GET

Parameters

This method doesn't require any request parameters.

Response

Return code: 201

Property Description Type
email The email address (login ID) of the current user
 string
fullName The full name of the current user as defined in their profile string
language The language defined for the current user string
numberOfMeetingsHosted The number of meetings that the current user has hosted since registration integer
personalUrl The personal URL of the current user
Note: Only returned when the personal URL is defined, and user is not a free user		 string
registrationDate The date when the current user registered their account datetime
(ISO 8601 format UTC time)
subscriptionType The user's subscription type
Possible return values:
  • Free
  • Trial
  • Lite
  • Pro
  • Business
 string
conferenceSettings*
Property Description Type
conferenceId The 9-digit conference ID, needed to sign in to the teleconference string
conferenceCallNumbersUrl A URL that will list all the audio conference numbers for this meeting string
organizerCode The presenter's 4-digit PIN code, granting him/her moderator control over the audio conference. Important: This is sensitive presenter information, and should not be shared with the viewers. string

*Note: "Free" users do not have conferenceSettings.

Example Request JSON
{}
Example cURL Request
curl -H "Authorization: Bearer {accesstoken}" -H "Content-Type: application/json" -X GET -d '{}' https://api.join.me/v1/user
Example Response
{
    "email":"youremail@join.me",
    "fullName":"Hardest Worker",
    "language":"en-US",
    "numberOfMeetingsHosted":57,
    "personalUrl":"hardwork",
    "registrationDate":"2014-03-22T20:45:00",
    "subscriptionType":"Pro",
    "conferenceSettings": {
        "conferenceId": "{9-digit audio bridge ID}",
        "conferenceCallNumbersUrl": "https://secure.join.me/api/public/intphone.aspx?conferenceId={9-digit audio bridge ID}",
        "organizerCode": "{4-digit presenter PIN}"
    }
}

Get User Audio Conference Information

Returns audio conference information for the join.me user corresponding to the OAuth 2.0 access token.

Endpoint URL
https://api.join.me/v1/user/conference
Method

GET

Parameters

This method doesn't require any request parameters.

Response

Return code: 200

Property Description Type
conferenceId The 9-digit conference ID, needed to sign in to the teleconference string
conferenceCallNumbersUrl A URL that will list all the audio conference numbers for this meeting string
organizerCode The presenter's 4-digit PIN code, granting him/her moderator control over the audio conference. Important: This is sensitive presenter information, and should not be shared with the viewers. string
conferenceCallNumbers List of international conference call numbers for this user. array of { country: string, city: string, region: string, phoneNumber: 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/user/conference
Example Response
{
    "conferenceId": "{9-digit audio bridge ID}",
    "conferenceCallNumbersUrl": "https://secure.join.me/api/public/intphone.aspx?conferenceId={9-digit audio bridge ID}",
    "organizerCode": "{4-digit presenter PIN}",
    "conferenceCallNumbers": [
        {
            "country": "",
            "city": "",
            "region": "",
            "phoneNumber": ""
        },
        {
            "country": "",
            "city": "",
            "region": "",
            "phoneNumber": ""
        }    
    ]
}

version 31 as of 7 years ago by joinme