Skip to content

List Catalog Entries (Custom Database)

List Catalog Entries

GET https://search.pex.com/api/v1/private/list

Lists ingested assets in your private Custom Database catalog using cursor-based pagination.

Request

Query Parameter Type Required Description
limit integer No Maximum number of catalog entries to return. Must be non-negative.
after string No Pagination cursor token specifying where to continue listing. Use the end_cursor value from the previous page.

Examples

import requests

ACCESS_TOKEN = "YOUR_ACCESS_TOKEN"

headers = {
    "Authorization": f"Bearer {ACCESS_TOKEN}",
}

# Fetch first page of 50 entries
response = requests.get(
    "https://search.pex.com/api/v1/private/list",
    headers=headers,
    params={
        "limit": 50,
    },
)

response.raise_for_status()
data = response.json()

print(f"Retrieved {len(data['entries'])} entries")
print(f"Has next page: {data['has_next_page']}")

# Fetch next page if available
if data["has_next_page"]:
    next_page = requests.get(
        "https://search.pex.com/api/v1/private/list",
        headers=headers,
        params={
            "limit": 50,
            "after": data["end_cursor"],
        },
    )
    next_page.raise_for_status()
    print(next_page.json())

ACCESS_TOKEN="YOUR_ACCESS_TOKEN"

# Fetch first page
curl -X GET "https://search.pex.com/api/v1/private/list?limit=50" \
  -H "Authorization: Bearer ${ACCESS_TOKEN}"

# Fetch subsequent page using end_cursor
# curl -X GET "https://search.pex.com/api/v1/private/list?limit=50&after=CURSOR_TOKEN" \
#   -H "Authorization: Bearer ${ACCESS_TOKEN}"

Response

A successful request returns a paginated list of catalog entries and pagination metadata.

{
  "entries": [
    {
      "provided_id": "my-unique-asset-001",
      "status": 1,
      "fingerprint_types": [
        1
      ]
    },
    {
      "provided_id": "my-unique-asset-002",
      "status": 1,
      "fingerprint_types": [
        1,
        3
      ]
    }
  ],
  "end_cursor": "eyJsYXN0X2lkIjoibXktdW5pcXVlLWFzc2V0LTAwMiJ9",
  "has_next_page": false
}

Field Definitions

Field Type Description
entries array List of catalog entry objects, each containing provided_id, status, and fingerprint_types.
end_cursor string Opaque cursor token for the last entry in the returned page. Pass this value as after to retrieve the next page.
has_next_page boolean Indicates whether additional entries are available beyond this page.