GET
/
datasets
List datasets
curl --request GET \
  --url https://app.getcensus.com/api/v1/datasets \
  --header 'Authorization: Bearer <token>'
{
  "status": "success",
  "pagination": {
    "total_records": 14,
    "per_page": 25,
    "prev_page": 1,
    "page": 2,
    "next_page": 3,
    "last_page": 10
  },
  "data": [
    {
      "type": "sql",
      "query": "SELECT id, name, email FROM users WHERE active = true",
      "source_id": 123,
      "name": "Users",
      "id": 157,
      "resource_identifier": "dataset:deduplicated_users",
      "description": "This dataset contains golden user records",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "cached_record_count": 123,
      "columns": [
        {
          "name": "email",
          "data_type": "string"
        }
      ]
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer token for the current workspace. Can be retrieved from the Workspace's settings page.

Query Parameters

​
page
number
default:1

Designates which page of results to return. Always starts at 1. If 0 is specified, it defaults to 1.

​
per_page
number
default:25

Determines the number of results on each page. It can't exceed 100.

Required range: x <= 100
​
order
enum<string>
default:desc

Organizes the results based on their creation time, either ascending or descending.

Available options:
asc,
desc
​
type
enum<string>

Filter datasets by type. Supports "entity_resolution" and "sql".

Available options:
entity_resolution,
sql

Response

200
application/json

Successfully retrieved the list of datasets.

A successfully fetched list of results.