Skip to main content
GET
List datasets

Authorizations

x-api-key
string
header
required

API key for authentication.

Query Parameters

page
integer
default:1

Page number to retrieve.

Required range: x >= 1
page_size
integer
default:100

Number of datasets per page.

Required range: 1 <= x <= 500

Filter datasets by name (case-insensitive substring match).

latest_status
enum<string>

Filter by dataset status.

Processing status of a dataset.

  • pending: Dataset created, entities queued for enrichment.
  • enriching: Entities are being enriched.
  • ready: All entities enriched and indexed — ready for use in jobs.
  • failed: One or more entity enrichments failed.
Available options:
pending,
enriching,
ready,
failed
sort_by
enum<string>
default:created_at

Fields available for sorting dataset list results.

Available options:
name,
created_at,
status
sort_order
enum<string>
default:desc

Sort direction for list results.

  • asc: ascending (oldest or smallest first)
  • desc: descending (newest or largest first)
Available options:
asc,
desc
ownership
enum<string>
default:all

Controls which resources are returned based on ownership.

  • all: Returns resources owned by the user and resources shared with them (default, backward compatible).
  • own: Returns only resources created by the authenticated user.
  • shared: Returns only resources shared with the user by others.
Available options:
all,
own,
shared
project_id
string<uuid>

Filter results to resources belonging to this project.

Response

Paginated list of datasets.

datasets
object[]
required

Array of dataset objects for this page.

total
integer
required

Total number of datasets matching the filter criteria.

Example:

5

page
integer
required

Current page number.

Example:

1

page_size
integer
required

Number of datasets per page.

Example:

100