API Reference

Datasets

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get dataset by ID

client.datasets.retrieve(stringid, RequestOptionsoptions?): Dataset { id, inserted_at, name, 6 more }

GET/api/v1/datasets/{id}

Get dataset by ID

ParametersExpand Collapse

id: string

ReturnsExpand Collapse

Dataset { id, inserted_at, name, 6 more }

id: string

Dataset ID

formatuuid

inserted_at: string

Creation timestamp

formatdate-time

name: string

Dataset name

slug: string

URL-friendly slug

updated_at: string

Last update timestamp

formatdate-time

attribution?: string | null

Attribution text

description?: string | null

Dataset description

license?: string | null

License identifier

source_url?: string | null

Source data URL

Get dataset by ID

TypeScript

HTTP

TypeScript

Python

Java

Kotlin

Go

Ruby

CLI Tool

PHP

C#

import Plaza from '@plazafyi/sdk';

const client = new Plaza({
  apiKey: process.env['PLAZA_API_KEY'], // This is the default and can be omitted
});

const dataset = await client.datasets.retrieve('id');

console.log(dataset.id);

200 example

{
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "inserted_at": "2019-12-27T18:11:19.117Z",
  "name": "name",
  "slug": "slug",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "attribution": "attribution",
  "description": "description",
  "license": "license",
  "source_url": "source_url"
}

Returns Examples

200 example

{
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "inserted_at": "2019-12-27T18:11:19.117Z",
  "name": "name",
  "slug": "slug",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "attribution": "attribution",
  "description": "description",
  "license": "license",
  "source_url": "source_url"
}