Skip to main content
GET
/
v1
/
assets
/
{assetTypeName}
List Assets
curl --request GET \
  --url https://api.us.lexful.app/v1/assets/{assetTypeName} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Account-ID: <api-key>'
import requests

url = "https://api.us.lexful.app/v1/assets/{assetTypeName}"

headers = {
"Authorization": "Bearer <token>",
"X-Account-ID": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)
const options = {
method: 'GET',
headers: {Authorization: 'Bearer <token>', 'X-Account-ID': '<api-key>'}
};

fetch('https://api.us.lexful.app/v1/assets/{assetTypeName}', 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.us.lexful.app/v1/assets/{assetTypeName}",
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>",
"X-Account-ID: <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.us.lexful.app/v1/assets/{assetTypeName}"

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

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("X-Account-ID", "<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.us.lexful.app/v1/assets/{assetTypeName}")
.header("Authorization", "Bearer <token>")
.header("X-Account-ID", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.us.lexful.app/v1/assets/{assetTypeName}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Account-ID"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "items": [
    {
      "id": "019983a9-c4c0-73af-aec9-463feeadc2e7",
      "organization_id": "019983a9-c4bf-77da-a35b-5eb177b7b859",
      "organization_name": "Acme Corporation",
      "visibility": "inherit",
      "owned_by": "019983a9-c4c0-73af-aec9-463feeadc2e7",
      "name": "John Doe",
      "first_name": "John",
      "last_name": "Doe",
      "title": "CTO",
      "important": true,
      "contact_type": "Decision Maker",
      "contact_methods": [
        {
          "type": "Email",
          "value": "john.doe@example.com"
        },
        {
          "type": "Mobile",
          "value": "+1-555-0123"
        }
      ],
      "preferred_contact_method": "Email",
      "references": {
        "location": "019983a9-c4c1-7abc-def0-123456789abc"
      },
      "created_at": "2024-01-15T10:30:00.000Z",
      "updated_at": "2024-01-20T14:45:00.000Z",
      "created_by": "019983a9-c4c0-73af-aec9-463feeadc2e7",
      "updated_by": "019983a9-c4c0-73af-aec9-463feeadc2e7"
    }
  ],
  "total": 123,
  "limit": 123,
  "offset": 123
}
{
"status": 123,
"message": "<string>",
"error_id": "<string>",
"error_code": "<string>",
"developer_message": "<string>"
}
{
"status": 123,
"message": "<string>",
"error_id": "<string>",
"error_code": "<string>",
"developer_message": "<string>"
}
{
"status": 123,
"message": "<string>",
"error_id": "<string>",
"error_code": "<string>",
"developer_message": "<string>"
}
{
"status": 123,
"message": "<string>",
"error_id": "<string>",
"error_code": "<string>",
"developer_message": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer token

X-Account-ID
string
header
required

Account ID

Path Parameters

assetTypeName
string
required

Asset type name

Query Parameters

organization_id
string<uuid>

Filter by organization

name
string

Filter by asset name

Full-text search query

include_deleted
boolean

Include soft-deleted assets in results (default: false)

expand
string

Comma-separated list of fields to expand (e.g., "tags", "references", "references.referenceName")

tags
string

Comma-separated tag ids; returns assets carrying ANY of these tags.

tag_parent_not
string

Parent tag id — returns only assets that carry none of the child tags under that parent

fields
string

Comma-separated list of fields to return, or "*" for all fields. Default excludes richtext fields for performance.

sort
string

Field name to sort by

order
enum<string>

Sort order

Available options:
ASC,
DESC
limit
number
default:100
Required range: 1 <= x <= 1000
offset
number
default:0
Required range: x >= 0
filter
string

URL-encoded JSON AND/OR filter tree for complex queries. A node is a group {"and":[...]} / {"or":[...]} or a leaf — a bracket-notation string "field[operator]=value" (the same syntax as the flat params above). Composes as an additional AND alongside the bracket-notation filters. Max nesting depth 3, max 50 conditions.

Response

Default Response

items
object[]
required
total
number
required

Total number of items available

limit
number
required

Number of items returned

offset
number
required

Number of items skipped