GET https://api.vidyard.com/dashboard/v1/organizations
View all organizations accessible by this user

GET https://api.vidyard.com/dashboard/v1/organizations/:id/family
View all organizations accessible by this user within a family

View organizations accessible by this 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
/v1/organizations
Accept: application/json

RESPONSE
200 (Ok)
{
  "organizations": [

      "name": "it@marketing.com",
      "id": 28,
      "parent_id": 1,
      "account_id": 1,
      "org_type": null,
      "created_at": 1392405501,
      "updated_at": 1392405501,
      "embed_domain": "http://embed.vidyard.com",
      "secure_embed_domain": "https://secure.vidyard.com",
      "playback_domain": "//play.vidyard.com"
    }
  ],
  "summary": {
    "page": 1,
    "per_page": 200,
    "count": 1
  }
}

 REQUEST
/v1/organizations/28/family
Accept: application/json

RESPONSE
200 (Ok)
{
  "organizations": [
    {
      "name": "it@marketing.com",
      "id": 28,
      "parent_id": 1,
      "account_id": 1,
      "org_type": "self_serve",
      "created_at": 1392405501,
      "updated_at": 1392405501,
      "embed_domain": "http://embed.vidyard.com",
      "secure_embed_domain": "https://secure.vidyard.com",
      "playback_domain": "//play.vidyard.com"
    }
  ],
  "summary": {
    "page": 1,
    "per_page": 200,
    "count": 1
  }
}

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
org_type
optional

Filters by the organization type

Validations:

  • Must be a String
owned_by
optional

Filters by organization owner

Validations:

  • Parameter has to be Integer.
accessible_by_team_id
optional

Filters to organizations accessible by the provided team

Validations:

  • Parameter has to be Integer.
account_id
optional

Filter to organizations owned by the provided account

Validations:

  • Parameter has to be Integer.
ancestor_id
optional

Filters to organizations descending from provided ancestor_id

Validations:

  • Parameter has to be Integer.
parent_id
optional

Filter to children of the provided parent_id account

Validations:

  • Parameter has to be Integer.
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.
query
optional

A string used to search for organizations by name within the scope of an account - Only works if ‘account_id’ parameter is set

Validations:

  • Must be a String