Users (Legacy Roles)

View, remove and invite Vidyard users to roles.

Supported Formats

json
>>>

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

Gets 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 applied when per_page is used
Default: 1

Validations:

  • Parameter has to be Integer.
>>>

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

Gets 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
Gets a user

Gets 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.
>>>

PATCH https://api.vidyard.com/dashboard/v1/users
Updates user's information

Updates user’s information

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
{
  users: [
    {
      "email": "coolguy@vidyard.com",
      "first_name": "Cool",
      "last_name": "Guy",
      "job_title": "Bossman",
      "calendar_link": "www.coolcal.com"
    },
    {
      "email": "radguy@vidyard.com",
      "first_name": "Rad",
      "last_name": "Guy",
      "job_title": "Helper",
      "calendar_link": "www.radcal.com"
    }
  ]
}
RESPONSE
200 (OK)

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