list

List datasets belonging to a given organization or user

HTTP Request

GET /api/v1/organizations/:organizationId/datasets
GET /api/v1/users/:userId/datasets

Parameters

Value

Description

Path parameters

:organizationId

integer | string

Organization shortName or persistent numeric identifier for the organization

:userId

integer | string

userName or persistent numeric identifier for the user

Query parameters

fields

string

Required. Comma-separated list of fields.

maxResults

unsigned integer

Optional. Maximum number of results to return. Defaults to 25, may not exceed 100.

pageToken

string

Optional. Page token, returned by a previous call, to request the next page of results.

accessLevel

string

Optional. The requesting user's access level to the dataset. Must be one of overview ,metadata ,data

Authorization

Optional. Only publicly visible datasets will be returned if no authorization is provided.

An API access token can be specified in the request header or as a query parameter (read more). In this case, only datasets visible to the access token's owner will be returned.

Response

If successful, this method returns a response body with the following structure:

{
"kind": "datasetList",
"nextPageToken": string,
"datasets": [
{
"id": integer,
"name": string,
"description": string,
// The accessLevel of the dataset to unauthenticated users
"publicAccessLevel": string("none"|"overview"|"metadata"|"data"),
// The accessLevel of the current token being used
// (this will never be higher than your access level)
"scopedAccessLevel": string("none"|"overview"|"metadata"|"data"),
// Your accessLevel
"accessLevel": string("overview"|"metadata"|"data"),
"url": string,
"createdAt": string(timestamp),
"updatedAt": string(timestamp),
// Note: permissionGroup will be null for public datasets
"permissionGroup": {
"id": integer,
"name": string,
"url": string
},
"collections": [
{
"id": integer,
"name": string,
"url": string
}
],
// Note: entity may be null
"entity": {
"name": string
},
"tags": [
{
"name": string
}
]
}
]
}