View, create, or update organizations
Get a single Organization
| 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 |
REQUEST
Accept: application/json
RESPONSE
200 (Ok)
{
"name": "it@marketing.com",
"id": 28,
"parent_id": 27,
"account_id": 27,
"embed_domain": "http://embed.vidyard.com",
"secure_embed_domain": "https://secure.vidyard.com",
"playback_domain": "//play.vidyard.com"
}
| Param name | Description |
|---|---|
|
auth_token optional |
API token needed to authorize requests Validations:
|
Update an Organization
| 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 |
REQUEST
Accept: application/json
{
"name": "foo@marketing.com",
}
RESPONSE
200 (Ok)
{
"name": "foo@marketing.com",
"id": 28,
"parent_id": 27,
"account_id": 27,
"embed_domain": "http://embed.vidyard.com",
"secure_embed_domain": "https://secure.vidyard.com",
"playback_domain": "//play.vidyard.com"
}
| Param name | Description |
|---|---|
|
auth_token optional |
API token needed to authorize requests Validations:
|
|
name optional |
Name of the Organization Validations:
|
View accounts associated with auth token
| 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 |
REQUEST
Accept: application/json
RESPONSE
200 (Ok)
[
{
"name": "it@marketing.com",
"role_attributes": [
{
"id": 67,
"name": "Admin",
"auth_token": "<MY_AUTH_TOKEN>",
"can_view_billing": true,
"can_edit_players": true,
"can_invite_users": true,
"can_invite_child_account_users": true,
"can_create_child_accounts": true
},
{
"id": 68,
"name": "User",
"auth_token": "<MY_AUTH_TOKEN>",
"can_view_billing": false,
"can_edit_players": true,
"can_invite_users": false,
"can_invite_child_account_users": true,
"can_create_child_accounts": true
}
],
"id": 28,
"created_at": 1392405501,
"updated_at": 1392405501,
"embed_domain": "http://embed.vidyard.com",
"secure_embed_domain": "https://secure.vidyard.com",
"playback_domain": "//play.vidyard.com"
}
]
| Param name | Description |
|---|---|
|
auth_token optional |
API token needed to authorize requests Validations:
|
View organizations accessible by this user
| 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 |
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
}
}
| Param name | Description |
|---|---|
|
auth_token optional |
API token needed to authorize requests Validations:
|
|
org_type optional |
Filters by the organization type Validations:
|
|
owned_by optional |
Filters by organization owner Validations:
|
|
accessible_by_team_id optional |
Filters to organizations accessible by the provided team Validations:
|
|
account_id optional |
Filter to organizations owned by the provided account Validations:
|
|
ancestor_id optional |
Filters to organizations descending from provided ancestor_id Validations:
|
|
parent_id optional |
Filter to children of the provided parent_id account Validations:
|
|
per_page optional |
The number of items to show per page Validations:
|
|
page optional |
The page number to include in the response Validations:
|
|
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:
|