Get Project by ID | Frame.io API Documentation

Fetch a Project via its ID

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

project_idstringRequired

Query parameters

includestringOptional

Response

Project success response

archive_statusenum

Archival status for this Project

Allowed values:

archived_atstringformat: "date-time"

When a Project was archived

archived_file_countintegerDefaults to 0

archived_storageintegerDefaults to 0

collaborator_countintegerDefaults to 0

deleted_atstringformat: "date-time"

If deleted, when this Project was deleted

descriptionstring

file_countintegerDefaults to 0

folder_countintegerDefaults to 0

idstringformat: "uuid"

ignore_archivebooleanDefaults to false

inserted_atstringformat: "date-time"

When was this Project created

invite_urlstring

namestring

Name of this Project

owner_idstringformat: "uuid"

privatebooleanDefaults to false

project_preferencesobject

read_onlybooleanDefaults to false

root_assetobject

Accepts arbitrary key/value pairs for storing information on an asset

root_asset_idstringformat: "uuid"

sharedbooleanDefaults to false

storageintegerDefaults to 0

teamobject

team_idstringformat: "uuid"

updated_atstringformat: "date-time"

user_permissionsobject

user_preferencesobject

watermarkobject

Errors

401

Unauthorized Error

404

Not Found Error

1	import requests
2
3	url = "https://api.frame.io/v2/projects/project_id"
4
5	headers = {"Authorization": "Bearer <token>"}
6
7	response = requests.get(url, headers=headers)
8
9	print(response.json())

1	{
2	"id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
3	"name": "My Project",
4	"owner_id": "dddddddd-dffd-dddd-dddd-dddddddddddd",
5	"private": false,
6	"project_preferences": {},
7	"root_asset_id": "cccccccc-cccc-cccc-cccc-cccccccccccc",
8	"team_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
9	}

1	import requests
2
3	url = "https://api.frame.io/v2/projects/project_id"
4
5	headers = {"Authorization": "Bearer <token>"}
6
7	response = requests.get(url, headers=headers)
8
9	print(response.json())

1	{
2	"id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
3	"name": "My Project",
4	"owner_id": "dddddddd-dffd-dddd-dddd-dddddddddddd",
5	"private": false,
6	"project_preferences": {},
7	"root_asset_id": "cccccccc-cccc-cccc-cccc-cccccccccccc",
8	"team_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
9	}