Get Assets - Topsort Documentation

Get Assets

curl --request GET \
  --url https://api.topsort.com/public/v1/assets/assets \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.topsort.com/public/v1/assets/assets', 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.topsort.com/public/v1/assets/assets",
  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: Bearer <token>"
  ],
]);

$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.topsort.com/public/v1/assets/assets"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.topsort.com/public/v1/assets/assets")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "hasMore": true,
  "assets": [
    {
      "id": "<string>",
      "name": "<string>",
      "status": "pending_upload",
      "productIds": [
        "<string>"
      ],
      "brands": [
        "<string>"
      ],
      "metadata": {},
      "isExternal": true,
      "collections": [
        "<string>"
      ],
      "mimetype": "<string>",
      "url": "<string>"
    }
  ],
  "nextPage": "SSBzb2xlbW5seSBzd2VhciB0aGF0IEkgYW0gdXAgdG8gbm8gZ29vZAo="
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

GET

/

public

/

v1

/

assets

/

assets

Get Assets

curl --request GET \
  --url https://api.topsort.com/public/v1/assets/assets \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.topsort.com/public/v1/assets/assets', 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.topsort.com/public/v1/assets/assets",
  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: Bearer <token>"
  ],
]);

$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.topsort.com/public/v1/assets/assets"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.topsort.com/public/v1/assets/assets")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "hasMore": true,
  "assets": [
    {
      "id": "<string>",
      "name": "<string>",
      "status": "pending_upload",
      "productIds": [
        "<string>"
      ],
      "brands": [
        "<string>"
      ],
      "metadata": {},
      "isExternal": true,
      "collections": [
        "<string>"
      ],
      "mimetype": "<string>",
      "url": "<string>"
    }
  ],
  "nextPage": "SSBzb2xlbW5seSBzd2VhciB0aGF0IEkgYW0gdXAgdG8gbm8gZ29vZAo="
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

A valid API key generated in Topsort's UI. Use the TSE API key if calling auctions or events API, otherwise use the TSC API key.

Query Parameters

vendor_id

string | null

Vendor ID.

collection_name

string | null

The collection name that the assets are associated with.

brand

string | null

The brand that the assets are associated with.

mimetype

enum<string> | null

The mimetype of the assets.

Available options:

image/jpeg,

image/png,

image/gif,

image/webp,

text/html,

video/mp4,

video/quicktime,

application/json,

text/vtt

status

enum<string> | null

The approval status of the assets.

Available options:

pending_upload,

pending_approval,

upload_error,

approved,

rejected

asset_ids

string[] | null

The list of asset ids.

next_page

string | null

Pagination cursor as provided in an earlier response. If provided will fetch the next page of results.

limit

integer

default:50

The maximum number of items to return per page.

Required range: 1 <= x <= 100

Response

Successful Response

hasMore

boolean

required

Flag that indicates whether more results are available. true indicates there is a next page of results. false indicates this response contains the last page of results.

assets

AssetResponse · object[]

required

List of assets

Show child attributes

nextPage

string | null

Pagination cursor. Provide this value as a next_page query parameter in a new request to retrieve the next page of results.

Minimum string length: 1

Example:

"SSBzb2xlbW5seSBzd2VhciB0aGF0IEkgYW0gdXAgdG8gbm8gZ29vZAo="