View, remove and invite Vidyard users to roles.

Supported Formats

json

GET https://api.vidyard.com/dashboard/v1/roles/:role_id/users
Get a list of all users for a role

Get a list of all users for a role

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
200 (OK)
{
  "users": [
    {
      "id": 159323,
      "email": "ceo@company.com",
      "first_name": "Big",
      "last_name": "Bossman",
      "created_at": 1399043509,
      "updated_at": 1412950695
    },
    {
      "id": 782942,
      "email": "good.employee@company.com",
      "first_name": "Wes",
      "last_name": "Janson",
      "created_at": 1396437334,
      "updated_at": 1412952533
    },
    {
      "id": 782312,
      "email": "other.employee@company.com",
      "first_name": "Dash",
      "last_name": "Rendar",
      "created_at": 1399263328,
      "updated_at": 1412486444
    }
  ],
  "summary": {
    "page": 1,
    "per_page": 15,
    "count": 3
  }
}

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.


GET https://api.vidyard.com/dashboard/v1/roles/:role_id/users/:id
Get a user

Get a 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
Accept: application/json

RESPONSE
200 (OK)
{
  "id": 159323,
  "email": "ceo@company.com",
  "first_name": "Big",
  "last_name": "Bossman",
  "created_at": 1399043509,
  "updated_at": 1412950695
}

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

id
required

Validations:

  • Parameter has to be Integer.


GET https://api.vidyard.com/dashboard/v1/users/:id
Get a user

Get a 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
Accept: application/json

RESPONSE
200 (OK)
{
  "id": 159323,
  "email": "ceo@company.com",
  "first_name": "Big",
  "last_name": "Bossman",
  "created_at": 1399043509,
  "updated_at": 1412950695
}

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

id
required

Validations:

  • Parameter has to be Integer.


DELETE https://api.vidyard.com/dashboard/v1/roles/:role_id/users/:id
Remove a user from a role

Remove a user from a role

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
409 Conflict: Conflict with the current state of the resource

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

id
required

Validations:

  • Parameter has to be Integer.


POST https://api.vidyard.com/dashboard/v1/roles/:role_id/invitations
Invite a new or existing user to a role

Invite a new or existing user to a role

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
409 Conflict: Conflict with the current state of the resource
422 Unprocessable Entity: body has wrong attributes

Examples

REQUEST
Content-Type: application/json
{
  "email": "good.employee@company.com",
  "reply_to_email": "admin@company.com"
}

RESPONSE
201 (Created)
{
  "id": 782942,
  "email": "good.employee@company.com"
}

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

The email address of the user to invite to the specified role

Validations:

  • Must be a String

reply_to_email
optional

The email address used in the reply to field of the invitation email

Validations:

  • Must be a String


GET https://api.vidyard.com/dashboard/v1/roles/:role_id/invitations
Get a list of invitations for a role

Get a list of invitations for a role

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
200 (OK)
{
  "invitations": [
    {
      "id": 159323,
      "email": "ceo@company.com"
    },
    {
      "id": 782942,
      "email": "good.employee@company.com"
    },
    {
      "id": 782312,
      "email": "other.employee@company.com"
    }
  ]
}

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


DELETE https://api.vidyard.com/dashboard/v1/roles/:role_id/invitations/:id
Delete an invitation

Delete an invitation

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

id
required

Validations:

  • Parameter has to be Integer.