GET /datasets/:id

Description

Retrieve schema and metadata for a given dataset. The ID of the dataset you want to access is required as a path parameter for this endpoint. If you want to retrieve the contents of a dataset, call the /records:retrieve endpoint.

Path Parameter

Path Parameter	Description	Note
`:id`	Passed through the URL. This ID belongs to the dataset you want to access, and can be found in the response body response body of `GET /datasets`.	Required

URL Structure

https://app.movementinfrastructure.org/api/v1/datasets/:id

Example Response Body

{
    "datasetId": "d280d9ce-7138-4978-a88d-dacb9641bd76",
    "name": "October Door Knocking",
    "description": "All of the doors for knocking",
    "dateCreated": "2024-08-19T14:29:52.229139",
    "recordCount": 500,
    "dateLastRecordUpdated": null,
    "createdBy": {
        "userId": 11111,
        "displayName": "My Test DXAPI App",
        "email": ""
     },
     "createdByWorkspace": {
       "workspaceId": 1235643,
       "displayName": "Soledad for Governor"
     },
    "datasetTags": [
      {
        "datasetTagId": "an1ex7a-543m-8989-11p0-23le456789",
        "name": "My Test DXAPI App",
        "movementAppId": "789ex3a5-mpl3-43f0-e198-x45a9m58p1ee"
        }
    ],
   "datasetSchema": {
        "datasetSchemaId": 123,
        "properties": [
            {
              "type": "string",
              "required": true,
              "name": "van_id"
            },
            {
              "type": "string",
              "required": true,
              "name": "phone_number"
            },
            {
              "type": "string",
              "required": true,
              "name": "last_name"
            },
            {
              "name": "knock_count",
              "required": true,
              "type": "integer"
            },
            {
              "name": "answered_door",
              "required": true,
              "type": "boolean"
            }
        ],
        "primaryKey": [
            "van_id"
        ]
    }
}