Skip to navigation

/dataset/{dataset_uuid}/{limit}/{offset}

View as Markdown

Retrieves a paginated list of records from a dataset.

Authentication

This request uses a pre-request script to automatically obtain a bearer token from {{url}}/token using the {{apiuser}} and {{apipass}} environment variables. The token is stored in {{token}} and used for authorization.

Path Parameters

ParameterTypeRequiredDescription
dataset_uuidstringYesThe UUID of the dataset to retrieve records from (e.g. ddc5e9ba834ad596cc31aebb1225)
limitintegerNoMaximum number of records to return. Defaults to 100 if not specified
offsetintegerNoZero-based offset for pagination. Use with limit to page through results

Example Request

GET {{url}}/dataset/ddc5e9ba834ad596cc31aebb1225/3/0

Retrieves the first 3 records from dataset ddc5e9ba834ad596cc31aebb1225.

Example Response (200 OK)

{
"count": 3,
"records": [
{
"database_uuid": "ddc5e9ba834ad596cc31aebb1225",
"internal_id": 640186,
"record_name": "R040003",
"record_uuid": "c67a06e7b4a6c8d7d11bab1588ce",
"template_uuid": "60231f230a3c7b73e0f0d1f1deea",
"metadata_for_uuid": "",
"_record_metadata": {
"_create_date": "2004-12-01 00:00:00",
"_update_date": "2026-03-19 17:57:59",
"_create_auth": "rruff@rruff.info",
"_public_date": "2005-05-25 00:00:00"
},
"fields": [
{
"field_name": "Sample ID",
"field_uuid": "b5973a5ac47ec4afd1db49e2b00f",
"template_field_uuid": "3e2259d0039f2c5cc912b8f92681",
"id": 7068,
"value": 1
},
{
"field_name": "RRUFF ID",
"field_uuid": "ee88404d73886150b59dd07cbb12",
"template_field_uuid": "d0e7a8e1e42d8159008116130e86",
"id": 7069,
"value": "R040003"
}
],
"records": []
}
]
}

Response Fields

FieldTypeDescription
countintegerTotal number of records returned in this response
recordsarrayList of record objects

Each object in records contains:

FieldTypeDescription
database_uuidstringUUID of the parent database
internal_idintegerInternal numeric identifier for the record
record_namestringHuman-readable name of the record
record_uuidstringUnique identifier for this record
template_uuidstringUUID of the template this record is based on
metadata_for_uuidstringUUID of the record this record provides metadata for (empty if not applicable)
_record_metadataobjectAudit metadata including create/update dates and author
fieldsarrayList of field objects containing the record’s data values
recordsarrayList of child records associated with this record

Each object in fields contains:

FieldTypeDescription
field_namestringHuman-readable name of the field
field_uuidstringUnique identifier for this field instance
template_field_uuidstringUUID of the template field definition
idintegerInternal numeric ID of the field
valuestringnumber
valuesarrayThe field’s selected option(s) (present for radio/select fields)
_field_metadataobjectAudit metadata for the field

Response headers

Access-Control-Allow-OriginstringOptional
Access-Control-Allow-MethodsstringOptional
Access-Control-Allow-HeadersstringOptional
Access-Control-Expose-HeadersstringOptional
Access-Control-Max-AgestringOptional
Cache-ControlstringOptional
X-Debug-TokenstringOptional
Keep-AlivestringOptional

Response

OK
countinteger
recordslist of objects