Get a File's metadata
curl --request GET \
--url https://api.assembly.com/v1/files/{id} \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api.assembly.com/v1/files/{id}"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://api.assembly.com/v1/files/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.assembly.com/v1/files/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.assembly.com/v1/files/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.assembly.com/v1/files/{id}")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.assembly.com/v1/files/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"additionalFields": {},
"channelId": "a8f2c1d4-1234-4abc-9def-0123456789ab",
"clientPermissions": "read_write",
"createdAt": "<string>",
"creatorId": "f4a1b2c3-1234-4abc-9def-0123456789ab",
"data": "<string>",
"downloadUrl": "<string>",
"fields": {
"eSignatureStatus": "done",
"linkUrl": "https://example.com/brochure.pdf",
"name": "brochure.pdf",
"path": "/contracts/2024",
"size": 20480,
"status": "complete"
},
"id": "<string>",
"identityId": "<string>",
"lastModifiedBy": {
"id": "f4a1b2c3-1234-4abc-9def-0123456789ab",
"object": "internalUser"
},
"object": "<string>",
"previousAttributes": {},
"ref": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"uploadUrl": "<string>"
}{
"code": "<string>",
"data": "<unknown>",
"message": "<string>"
}{
"code": "<string>",
"data": "<unknown>",
"message": "<string>"
}{
"code": "<string>",
"data": "<unknown>",
"message": "<string>"
}{
"code": "<string>",
"data": "<unknown>",
"message": "<string>"
}Files
Get a File's metadata
Returns the metadata for a single file, folder, or link by its id.
GET
/
v1
/
files
/
{id}
Get a File's metadata
curl --request GET \
--url https://api.assembly.com/v1/files/{id} \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api.assembly.com/v1/files/{id}"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://api.assembly.com/v1/files/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.assembly.com/v1/files/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.assembly.com/v1/files/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.assembly.com/v1/files/{id}")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.assembly.com/v1/files/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"additionalFields": {},
"channelId": "a8f2c1d4-1234-4abc-9def-0123456789ab",
"clientPermissions": "read_write",
"createdAt": "<string>",
"creatorId": "f4a1b2c3-1234-4abc-9def-0123456789ab",
"data": "<string>",
"downloadUrl": "<string>",
"fields": {
"eSignatureStatus": "done",
"linkUrl": "https://example.com/brochure.pdf",
"name": "brochure.pdf",
"path": "/contracts/2024",
"size": 20480,
"status": "complete"
},
"id": "<string>",
"identityId": "<string>",
"lastModifiedBy": {
"id": "f4a1b2c3-1234-4abc-9def-0123456789ab",
"object": "internalUser"
},
"object": "<string>",
"previousAttributes": {},
"ref": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"uploadUrl": "<string>"
}{
"code": "<string>",
"data": "<unknown>",
"message": "<string>"
}{
"code": "<string>",
"data": "<unknown>",
"message": "<string>"
}{
"code": "<string>",
"data": "<unknown>",
"message": "<string>"
}{
"code": "<string>",
"data": "<unknown>",
"message": "<string>"
}Authorizations
Path Parameters
File id
Response
OK
ChannelID is the file channel the item belongs to.
Example:
"a8f2c1d4-1234-4abc-9def-0123456789ab"
ClientPermissions controls client read/write access for folders.
Available options:
read_write, read_only Example:
"read_write"
CreatorId is the id of the user who created the file.
Example:
"f4a1b2c3-1234-4abc-9def-0123456789ab"
DownloadURL is a presigned URL for downloading the file's contents.
Fields holds the item's name, path, link target, size, and status.
Show child attributes
Show child attributes
LastModifiedBy identifies the user who last modified the file.
Show child attributes
Show child attributes
UpdatedDate is when the file was last updated.
UploadURL is a presigned URL for uploading the file's binary data, set on creation of an unuploaded file.