List shares
curl --request GET \
--url https://api-staging.pixwel.com/api/shares \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://api-staging.pixwel.com/api/shares"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://api-staging.pixwel.com/api/shares', 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-staging.pixwel.com/api/shares",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);
$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-staging.pixwel.com/api/shares"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
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-staging.pixwel.com/api/shares")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-staging.pixwel.com/api/shares")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body[
{
"_id": "507f1f77bcf86cd799439011",
"from": {
"_id": "507f1f77bcf86cd799439011",
"name": "<string>",
"emailNormal": "user@example.com",
"$links": {
"self": "//example.com/path/to/object"
}
},
"to": [
{
"_id": "507f1f77bcf86cd799439011",
"name": "<string>",
"emailNormal": "user@example.com",
"$links": {
"self": "//example.com/path/to/object"
}
}
],
"groups": "<unknown>",
"assets": [
{
"_id": "507f1f77bcf86cd799439011",
"project": "507f1f77bcf86cd799439011",
"studio": "507f1f77bcf86cd799439011",
"name": "<string>",
"slug": "<string>",
"type": "<string>",
"length": 123,
"thumbnail": "507f1f77bcf86cd799439011",
"notes": "<string>",
"created": 123,
"mediaType": "<string>",
"creative": true,
"$links": {
"self": "//example.com/path/to/object",
"project": "//example.com/path/to/object",
"studio": "//example.com/path/to/object",
"type": "//example.com/path/to/object",
"thumbnail": "//example.com/path/to/object"
},
"$permissions": {
"canAutosub": true,
"sources": {
"requests": {
"languages": "<unknown>",
"countries": "<unknown>"
},
"autosubs": {
"languages": "<unknown>",
"countries": "<unknown>"
}
},
"access": [
"<string>"
],
"tags": {
"online": true,
"broadcast": true,
"dcp": true,
"cmyk": true,
"rgb": true
},
"ingest": [
"<string>"
]
},
"$feedback": {
"share": "<unknown>",
"vote": "<unknown>",
"summary": "<unknown>"
}
}
],
"assetsCount": 123,
"assetCategory": "<string>",
"projectNames": [
"<string>"
],
"studios": [
"507f1f77bcf86cd799439011"
],
"tags": [
[
"<string>"
]
],
"urls": {
"playlist": "https://example.com/path/to/object",
"invite": "https://example.com/path/to/object"
},
"approved": true,
"feedback": {
"enabled": true
},
"created": 123,
"questions": "<unknown>",
"$links": {
"self": "//example.com/path/to/object",
"from": "//example.com/path/to/object"
},
"permissions": [
{
"_id": "507f1f77bcf86cd799439011",
"sources": {
"download": {
"ov": true,
"countries": [
"<string>"
],
"languages": [
"<string>"
]
},
"manageWorkRequests": {
"groups": "<unknown>"
},
"previews": {
"ov": true,
"countries": "<unknown>",
"languages": [
"<string>"
]
},
"requests": {
"ov": true,
"countries": "<unknown>",
"languages": "<unknown>"
},
"social": {
"ov": true,
"countries": "<unknown>",
"languages": "<unknown>"
},
"adminWorkRequests": {
"groups": "<unknown>"
}
},
"approved": true,
"project": "507f1f77bcf86cd799439011",
"assets": [
"507f1f77bcf86cd799439011"
],
"tags": [
"<string>"
],
"types": "<unknown>",
"access": {
"sharing": true,
"push": true,
"download": true,
"requests": true,
"notes": true,
"previews": true,
"manageWorkRequsts": true,
"projectAdminView": true,
"projectAdminUpdate": true,
"projectAdminEmbargos": true,
"workRequestReport": true,
"downloadReport": true,
"exceptionReport": true,
"groupSpendingReport": true,
"adminWorkRequests": true,
"shareVotingView": true,
"manageWorkRequests": true,
"ingest": true
},
"user": "507f1f77bcf86cd799439011",
"share": "507f1f77bcf86cd799439011",
"$links": {
"self": "//example.com/path/to/object"
}
}
],
"notes": "<string>"
}
]Shares
List shares
GET
/
shares
List shares
curl --request GET \
--url https://api-staging.pixwel.com/api/shares \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://api-staging.pixwel.com/api/shares"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://api-staging.pixwel.com/api/shares', 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-staging.pixwel.com/api/shares",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);
$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-staging.pixwel.com/api/shares"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
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-staging.pixwel.com/api/shares")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-staging.pixwel.com/api/shares")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body[
{
"_id": "507f1f77bcf86cd799439011",
"from": {
"_id": "507f1f77bcf86cd799439011",
"name": "<string>",
"emailNormal": "user@example.com",
"$links": {
"self": "//example.com/path/to/object"
}
},
"to": [
{
"_id": "507f1f77bcf86cd799439011",
"name": "<string>",
"emailNormal": "user@example.com",
"$links": {
"self": "//example.com/path/to/object"
}
}
],
"groups": "<unknown>",
"assets": [
{
"_id": "507f1f77bcf86cd799439011",
"project": "507f1f77bcf86cd799439011",
"studio": "507f1f77bcf86cd799439011",
"name": "<string>",
"slug": "<string>",
"type": "<string>",
"length": 123,
"thumbnail": "507f1f77bcf86cd799439011",
"notes": "<string>",
"created": 123,
"mediaType": "<string>",
"creative": true,
"$links": {
"self": "//example.com/path/to/object",
"project": "//example.com/path/to/object",
"studio": "//example.com/path/to/object",
"type": "//example.com/path/to/object",
"thumbnail": "//example.com/path/to/object"
},
"$permissions": {
"canAutosub": true,
"sources": {
"requests": {
"languages": "<unknown>",
"countries": "<unknown>"
},
"autosubs": {
"languages": "<unknown>",
"countries": "<unknown>"
}
},
"access": [
"<string>"
],
"tags": {
"online": true,
"broadcast": true,
"dcp": true,
"cmyk": true,
"rgb": true
},
"ingest": [
"<string>"
]
},
"$feedback": {
"share": "<unknown>",
"vote": "<unknown>",
"summary": "<unknown>"
}
}
],
"assetsCount": 123,
"assetCategory": "<string>",
"projectNames": [
"<string>"
],
"studios": [
"507f1f77bcf86cd799439011"
],
"tags": [
[
"<string>"
]
],
"urls": {
"playlist": "https://example.com/path/to/object",
"invite": "https://example.com/path/to/object"
},
"approved": true,
"feedback": {
"enabled": true
},
"created": 123,
"questions": "<unknown>",
"$links": {
"self": "//example.com/path/to/object",
"from": "//example.com/path/to/object"
},
"permissions": [
{
"_id": "507f1f77bcf86cd799439011",
"sources": {
"download": {
"ov": true,
"countries": [
"<string>"
],
"languages": [
"<string>"
]
},
"manageWorkRequests": {
"groups": "<unknown>"
},
"previews": {
"ov": true,
"countries": "<unknown>",
"languages": [
"<string>"
]
},
"requests": {
"ov": true,
"countries": "<unknown>",
"languages": "<unknown>"
},
"social": {
"ov": true,
"countries": "<unknown>",
"languages": "<unknown>"
},
"adminWorkRequests": {
"groups": "<unknown>"
}
},
"approved": true,
"project": "507f1f77bcf86cd799439011",
"assets": [
"507f1f77bcf86cd799439011"
],
"tags": [
"<string>"
],
"types": "<unknown>",
"access": {
"sharing": true,
"push": true,
"download": true,
"requests": true,
"notes": true,
"previews": true,
"manageWorkRequsts": true,
"projectAdminView": true,
"projectAdminUpdate": true,
"projectAdminEmbargos": true,
"workRequestReport": true,
"downloadReport": true,
"exceptionReport": true,
"groupSpendingReport": true,
"adminWorkRequests": true,
"shareVotingView": true,
"manageWorkRequests": true,
"ingest": true
},
"user": "507f1f77bcf86cd799439011",
"share": "507f1f77bcf86cd799439011",
"$links": {
"self": "//example.com/path/to/object"
}
}
],
"notes": "<string>"
}
]Authorizations
BasicAuthBearerAuth
Email address and password. A personal access token (pat_…) or session token (token-…) may also be sent in the password field, with any non-empty value as the username — a blank username short-circuits to a 401 before the token is read.
Headers
Optional pagination range (e.g. resources=0-9). Without it the full result set is returned.
Response
OK
Example:
"507f1f77bcf86cd799439011"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Shape not inferred — the sampled response had no entries
Show child attributes
Show child attributes
Additional entries are keyed by record id.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Shape not inferred — the sampled response had no entries
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I