Skip to main content

List Records

This endpoint retrieves a list of records within a specific collection in TaskingAI.

Endpoint

  • Method: GET
  • URL: https://api.tasking.ai/v1/collections/{collection_id}/records

Path Parameters

ParameterTypeDescription
collection_idstringThe unique identifier for the collection.

Header Parameters

All TaskingAI API requests require the following headers:

HeaderTypeDescription
Content-TypestringThe content type of the request. Set to application/json.
AuthorizationstringAPI key for authorization in the format Bearer $TASKINGAI_API_KEY. The key can be obtained in the project settings in your TaskingAI console.

Query Parameters

ParameterTypeRequiredDefaultDescription
limitintegerNo20The maximum number of records to retrieve.
orderstring or nullNodescDefines the sort order. Can accept values from asc or desc. The sort key is updated_timestamp.
afterstring or nullNonullA cursor indicating to retrieve records after a certain identifier.
beforestring or nullNonullA cursor indicating to retrieve records before a certain identifier.

Response Example

{
"status": "success",
"data": [
{}
],
"fetched_count": 0,
"has_more": true
}