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

url = "https://api.us.lexful.app/v1/asset_types"

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/asset_types', 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/asset_types",
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/asset_types"

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/asset_types")
.header("Authorization", "Bearer <token>")
.header("X-Account-ID", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.us.lexful.app/v1/asset_types")

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-c4bf-77da-a35b-5eb177b7b859",
      "account_id": "019983a9-c4bf-77da-a35b-5eb177b7b859",
      "name": "system.contact",
      "display_name": "Contacts",
      "description": "Contacts are people and identities associated with an organization",
      "is_system": true,
      "properties": [
        {
          "name": "first_name",
          "type": "string",
          "display_name": "First Name",
          "required": false
        },
        {
          "name": "last_name",
          "type": "string",
          "display_name": "Last Name",
          "required": false
        },
        {
          "name": "title",
          "type": "string",
          "display_name": "Title",
          "required": false
        },
        {
          "name": "important",
          "type": "boolean",
          "display_name": "Important",
          "required": true
        },
        {
          "name": "contact_type",
          "type": "string",
          "display_name": "Contact Type",
          "required": false,
          "enum": [
            "Approver",
            "Champion",
            "Decision Maker",
            "End User",
            "Evaluator",
            "Influencer",
            "Owner",
            "Other"
          ]
        },
        {
          "name": "contact_methods",
          "type": "array",
          "display_name": "Contact Methods",
          "required": false,
          "array": {
            "type": "object",
            "properties": [
              {
                "name": "type",
                "type": "string",
                "display_name": "Contact Method Type",
                "required": true,
                "enum": [
                  "Phone",
                  "Fax",
                  "Mobile",
                  "Email",
                  "Website",
                  "Twitter",
                  "LinkedIn",
                  "Other"
                ]
              },
              {
                "name": "value",
                "type": "string",
                "display_name": "Contact Method Value",
                "required": true
              }
            ]
          }
        },
        {
          "name": "preferred_contact_method",
          "type": "string",
          "display_name": "Preferred Contact Method",
          "required": false,
          "enum": [
            "Phone",
            "Fax",
            "Mobile",
            "Email",
            "Website",
            "Twitter",
            "LinkedIn",
            "Other"
          ]
        },
        {
          "name": "notes",
          "type": "richtext",
          "display_name": "Notes",
          "required": false
        }
      ],
      "references": [
        {
          "name": "location",
          "display_name": "Location",
          "required": false,
          "multiple": false,
          "target_asset_types": [
            "system.location"
          ]
        }
      ],
      "version": 1,
      "created_at": "2024-01-15T10:30:00.000Z",
      "updated_at": "2024-01-15T10:30: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>"
}

Authorizations

Authorization
string
header
required

Bearer token

X-Account-ID
string
header
required

Account ID

Query Parameters

names
string[]

Filter by one or more asset type names

display_name
string

Filter by display name

is_system
boolean

Filter by system asset type flag

include_deleted
boolean

Include soft-deleted asset types and properties (default: false)

limit
number
default:100
Required range: 1 <= x <= 1000
offset
number
default:0
Required range: x >= 0

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