Dataset column schema

GET

/api/v1/socrata/{portal}/dataset-columns/{dataset_id}

Last modified:2026-05-10 09:22:39

Maintainer:Not configured

OperationId:socrata_portal_dataset_columns_dataset_id

Column schema via api/views/{dataset_id}/columns.json. Returns field names (SoQL identifiers), display names, data types (number, text, calendar_date, point, etc.), and author descriptions. Use this to discover the exact fieldName values you should pass to $select, $where, $order on the rows endpoint.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Path Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200

application/json

Column definitions for the dataset schema.

Bodyapplication/json

Example

{
    "data": {
        "portal": "nyc",
        "domain": "data.cityofnewyork.us",
        "dataset_id": "erm2-nwe9",
        "count": 0,
        "columns": [
            {
                "id": 0,
                "name": "string",
                "fieldName": "string",
                "dataTypeName": "string",
                "description": "string",
                "position": 0,
                "renderTypeName": "string",
                "tableColumnId": 0,
                "width": 0,
                "format": {
                    "property1": "string",
                    "property2": "string"
                },
                "cachedContents": {
                    "property1": "string",
                    "property2": "string"
                }
            }
        ]
    },
    "meta": {
        "endpoint": "/api/v1/fred/us/cpi",
        "data_time": "2026-04-16T14:30:00Z",
        "response_time": "2026-04-16T14:30:12Z",
        "provider": "Sugra API v1.0.1",
        "source": "string",
        "fallback_used": true,
        "fallback_chain": [
            "string"
        ],
        "cached": true
    }
}

🟠401

🟠422

🟠429

🔴503

Modified at 2026-05-10 09:22:39

Portal category buckets

Fetch a single row by `:id`