listRows

HTTP Request

GET /tables/:tableReference/rows

Path parameters

Parameter

tableReference

Query parameters

Parameter

format

The response format. Either csv , jsonl, or arrow. Defaults to jsonl for the JSON-lines format.

selectedVariables

Optional. A comma separated list of the variables to return, case insensitive. The order of variables in this list will determine the order of values in the response.

If not specified, all variables belonging to the table will be returned.

maxResults

Optional. Maximum number of rows to return.

This endpoint extends the general API structure.

Authorization

This endpoint is accessible without authorization for tables which are public and under 100MB. However, certain rate limits may be enforced (and may change in the future) for unauthenticated users – we still recommend providing authorization information in the request header whenever possible.

Data access to the table is required. If a table's data is not public, your access token must have one of the following scopes:

  • data.data

  • data.edit

Learn more about authorization.

Request body

The request body must be empty.

Response body

The response is returned in the JSON Lines format, with each row represented as an object of key:value pairs.

// e.g.: ...table_ref/rows?selectedVariables=id,date,decimal,text
{"id":1, "date":"2012-01-01", "decimal":4.2, "text":"Some text"]
{"id":2, "date":"2012-01-01", "decimal":3.14, "text":"More text"]
...

Please note the following regarding response data formats:

  • Date variables are formatted as YYYY-MM-DD

  • DateTime variables are formatted at YYYY-MM-DD HH:MM:SS[.DDDDDD]

  • Time variables are formatted as HH:MM:SS[.DDDDDD]

  • Geography variables are formatted as well-known text (WKT)

Last updated

Was this helpful?