Skip to content

Get section tasks as dataframe

GET
/api/v1/dataframes/section/{gid}

Get section tasks as a DataFrame.

Per FR-API-DF-003, FR-API-DF-004, TDD-dynamic-schema-api:

  • Fetches tasks from the specified section
  • Returns DataFrame in JSON or Polars format based on Accept header
  • Supports all registered schemas via dynamic validation

Args: gid: Asana section GID. schema: Schema for extraction (base, unit, contact, business, offer, asset_edit, asset_edit_holder). Case-insensitive. limit: Number of items per page (1-100, default 100). offset: Pagination cursor from previous response. accept: Accept header for content negotiation.

Returns: DataFrame data in requested format with pagination metadata.

Raises: HTTPException: 400 if schema is invalid (includes valid_schemas list). HTTPException: 404 if section not found or has no parent project.

gid
required
Gid
string
schema
Schema

Schema to use for extraction. Valid values: base, unit, contact, business, offer, asset_edit, asset_edit_holder

string
default: base

Schema to use for extraction. Valid values: base, unit, contact, business, offer, asset_edit, asset_edit_holder

limit
Limit

Number of items per page

integer
default: 100 >= 1 <= 100

Number of items per page

offset
Any of:
string

Pagination cursor from previous response

DataFrame data in requested format

Example
{
"data": [
{
"gid": "123",
"name": "Task 1",
"type": "Unit"
}
],
"meta": {
"request_id": "abc123",
"timestamp": "2024-01-01T00:00:00Z",
"pagination": {
"limit": 100,
"has_more": false
}
}
}

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string