View, create, update and delete hub users.

Supported Formats

json

POST https://api.vidyard.com/dashboard/v1/hubs/:id/users
Invite a new hub user

Send an invitation to a new hub user

Supported Formats

json

Errors

Code Description
400 Bad Request: body has wrong syntax or unable to handle request
401 Unauthorized: auth_token omitted or authentication failed
403 Forbidden: This action cannot be performed
404 Not Found: The requested resource could not be found
406 Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Examples

REQUEST
Content-Type: application/json
{
  "email": "vbot@example.com",
  "message": "Join the hot vbot hotbot hub!"
}

RESPONSE
201 (Created)
{
  "email": "vbot@example.com",
  "id": 71,
  "invitation_accepted": false,
  "created_at": 1400695130,
  "updated_at": 1400695130
}

Params

Param name Description
auth_token
optional

API token needed to authorize requests
This can appear as an attribute in the body of the request or the query parameters on the URL

Validations:

  • Must be a String

email
required

email used to sign in

Validations:

  • Must be a String

message
optional

Optional custom message you wish to send to the invitee

Validations:

  • Must be a String


POST https://api.vidyard.com/dashboard/v1/hubs/:id/users/invitations
Create an invitation for a hub user

Create an invitation for a hub user

Supported Formats

json

Errors

Code Description
400 Bad Request: body has wrong syntax or unable to handle request
401 Unauthorized: auth_token omitted or authentication failed
403 Forbidden: This action cannot be performed
404 Not Found: The requested resource could not be found
406 Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Examples

REQUEST
Content-Type: application/json
{
  "email": "vbot@example.com"
}

RESPONSE
201 (Created)
{
  "invitation_url": "http://myhub.hubs.vidyard.com/invitation/accept?email=vbot%40example.com&invitation_token=6e1e8d9c497ab390d0141d3601219b9ed5111bb6f4b338a7c86c118b02aca8dd",
  "hub_user": {
    "email": "vbot@example.com",
    "id": 71,
    "invitation_accepted": false,
    "created_at": 1400695130,
    "updated_at": 1400695130
  }
}

Params

Param name Description
auth_token
optional

API token needed to authorize requests
This can appear as an attribute in the body of the request or the query parameters on the URL

Validations:

  • Must be a String

email
required

email used to sign in

Validations:

  • Must be a String


GET https://api.vidyard.com/dashboard/v1/hubs/:id/users
See all users of a hub

lists out all users of a hub with their id

Supported Formats

json

Errors

Code Description
400 Bad Request: body has wrong syntax or unable to handle request
401 Unauthorized: auth_token omitted or authentication failed
403 Forbidden: This action cannot be performed
404 Not Found: The requested resource could not be found
406 Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Examples

REQUEST
Accept: application/json

RESPONSE
{
  "users": [
      {
        "email": "vbot@test.com",
        "id": "1",
        "invitation_accepted": true,
        "created_at": 1411672027,
        "updated_at": 1411672141
      },
      {
        "id": "4",
        "email": "user@example.com",
        "invitation_accepted": true,
        "created_at": 1411671486,
        "updated_at": 1414789607
      }
  ],
  "summary":{
    "page": 1,
    "per_page": 2,
    "count": 5
  }
}

Params

Param name Description
auth_token
optional

API token needed to authorize requests
This can appear as an attribute in the body of the request or the query parameters on the URL

Validations:

  • Must be a String

per_page
optional

The number of items to show per page
Maximum: 200

Validations:

  • Parameter has to be Integer.

page
optional

The page number to include in the response
Only applies when per_page used
Default: 1

Validations:

  • Parameter has to be Integer.


DELETE https://api.vidyard.com/dashboard/v1/hubs/:id/users/:hub_user_id
Remove a user from the hub

Removes user from the hub

Supported Formats

json

Errors

Code Description
400 Bad Request: body has wrong syntax or unable to handle request
401 Unauthorized: auth_token omitted or authentication failed
403 Forbidden: This action cannot be performed
404 Not Found: The requested resource could not be found
406 Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Params

Param name Description
auth_token
optional

API token needed to authorize requests
This can appear as an attribute in the body of the request or the query parameters on the URL

Validations:

  • Must be a String