Progress API Setup Guide

The Track3D Progress API lets you retrieve and upload progress, sign users in, and read external assets and asset categories used in your projects.

Base URL: https://progress-api.dev.track3d.ai · Version: v1

Authentication

Include your API key on every request, with one exception.

x-api-key: YOUR_API_KEY

/v1/users/signin does not require the API key. Every other endpoint does.

Errors

Status	Meaning
400	Bad Request
401	Unauthorized
404	Not Found
500	Internal Server Error

Error shape (example)

{
  "status": false,
  "message": "Error details"
}

POST /v1/users/signin

Request body

{
  "email": "user@example.com",
  "password": "••••••••"
}

curl -X POST "https://progress-api.dev.track3d.ai/v1/users/signin" \
  -H "Content-Type: application/json" \
  -d '{"email":"user@example.com","password":"your_password"}'

Response — 201

{
  "success": true,
  "result": {
    "_id": "string",
    "firstName": "string",
    "lastName": "string",
    "email": "string",
    "contact": { "code": "string", "number": 0 },
    "dob": "string",
    "verified": true,
    "createdAt": "string",
    "updatedAt": "string",
    "__v": 0,
    "avatar": "string",
    "isSupportUser": true,
    "unReadNotifications": ["string"],
    "status": "string",
    "loginType": "string",
    "resetPasswordTimestamps": ["string"],
    "verificationTimestamps": ["string"],
    "userPreference": "string",
    "fullName": "string",
    "age": 0,
    "canResendVerification": true,
    "canResetPassword": true,
    "provider": "string",
    "token": "string",
    "refreshToken": "string"
  }
}

Error response

{ "status": false, "message": "Invalid credentials" }

Upload progress

POST /progress

Request body

{
  "projectId": "12345",
  "date": "2025-04-30",
  "status": "In Progress",
  "details": "Work started on the foundation."
}

curl -X POST "https://progress-api.dev.track3d.ai/progress" \
  -H "x-api-key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "projectId":"12345",
    "date":"2025-04-30",
    "status":"In Progress",
    "details":"Work started on the foundation."
  }'

Response — 201

{
  "id": "progress1",
  "projectId": "12345",
  "date": "2025-04-30",
  "status": "In Progress",
  "details": "Work started on the foundation."
}

Get progress (list)

GET /progress

Query parameters

Name	Type	Required	Description
`projectId`	string	Yes	Project ID
`date`	string (date)	No	Filter by date `YYYY-MM-DD`

curl -G "https://progress-api.dev.track3d.ai/progress" \
  -H "x-api-key: $API_KEY" \
  --data-urlencode "projectId=12345" \
  --data-urlencode "date=2025-04-30"

Response — 200

[
  {
    "id": "progress1",
    "projectId": "12345",
    "date": "2025-04-30",
    "status": "Completed",
    "details": "Progress details here."
  }
]

Get progress by ID

GET /progress/{id}

Path parameters

Name	Type	Required	Description
`id`	string	Yes	Progress entry ID

curl "https://progress-api.dev.track3d.ai/progress/progress1" \
  -H "x-api-key: $API_KEY"

Response — 200

{
  "id": "progress1",
  "projectId": "12345",
  "date": "2025-04-30",
  "status": "Completed",
  "details": "Foundation work completed."
}

Get external asset categories (by project)

GET /api/external-asset-categories

Query parameters

Name	Type	Required	Description
`project`	string	Yes	Project ID

curl -G "https://progress-api.dev.track3d.ai/api/external-asset-categories" \
  -H "x-api-key: $API_KEY" \
  --data-urlencode "project=pid"

Response — 200

{
  "success": true,
  "result": [
    {
      "status": "string",
      "drawing": "string",
      "_id": "string",
      "name": "string",
      "project": "string",
      "stages": [
        {
          "_id": "string",
          "name": "string",
          "sequence": 0,
          "color": "string",
          "uom": "string",
          "measurement": "string",
          "metrics": { "structureId": 0 },
          "predecessors": [0]
        }
      ],
      "description": "string",
      "createdAt": "2025-08-25T14:53:56.052Z",
      "updatedAt": "2025-08-25T14:53:56.052Z",
      "height": 0,
      "uom": "string",
      "id": "string"
    }
  ]
}

Get external assets (by structure + category)

GET /api/external-assets

Query parameters

Name	Type	Required	Description
`structure`	string	Yes	Structure ID
`category`	string	Yes	Category name or ID

curl -G "https://progress-api.dev.track3d.ai/api/external-assets" \
  -H "x-api-key: $API_KEY" \
  --data-urlencode "structure=sid123" \
  --data-urlencode "category=cat_name"

Response — 200

{
  "success": true,
  "result": [
    {
      "_id": "UJPeP7rjrmfK4sASkmYVVA",
      "category": "J0MqOKvgZqDBA5gQ6yaYhw",
      "shape": "Polyline",
      "points": [
        { "x": 518867.7664488507, "y": 3707128.323726985 }
      ],
      "properties": { "snapshotDate": "2000-01-01T00:00:00.000Z" },
      "snapshot": "1999-12-31T00:00:00.000Z",
      "doNotTrack": false,
      "stages": [
        { "_id": "XTU9LaDkj1_oiugf4y4Hkg", "percentage": 100, "date": "2024-06-24T00:00:00.000Z" }
      ]
    }
  ]
}

Data models

Progress

{
  "id": "progress1",
  "projectId": "12345",
  "date": "2025-04-30",
  "status": "Completed",
  "details": "Progress details here."
}

Field	Type	Notes
`id`	string	Generated ID
`projectId`	string	Project identifier
`date`	string (`YYYY-MM-DD`)	Progress date
`status`	string	e.g. `In Progress`, `Completed`
`details`	string	Free-form notes

ExternalAsset

{
  "_id": "UJPeP7rjrmfK4sASkmYVVA",
  "category": "J0MqOKvgZqDBA5gQ6yaYhw",
  "shape": "Polyline",
  "points": [{ "x": 518867.7, "y": 3707128.32 }],
  "properties": { "snapshotDate": "2000-01-01T00:00:00.000Z" },
  "snapshot": "1999-12-31T00:00:00.000Z",
  "doNotTrack": false,
  "stages": [{ "_id": "XTU9LaD...", "percentage": 100, "date": "2024-06-24T00:00:00.000Z" }]
}

ExternalAssetCategory

{
  "_id": "string",
  "name": "string",
  "project": "string",
  "stages": [
    { "_id": "string", "name": "string", "sequence": 0, "color": "string",
      "uom": "string", "measurement": "string", "metrics": { "structureId": 0 },
      "predecessors": [0] }
  ],
  "description": "string",
  "createdAt": "2025-08-25T14:53:56.052Z",
  "updatedAt": "2025-08-25T14:53:56.052Z",
  "height": 0,
  "uom": "string",
  "id": "string",
  "status": "string",
  "drawing": "string"
}

Request

{ "email": "user@example.com", "password": "••••••••" }

Response (success)

{
  "success": true,
  "result": {
    "_id": "string",
    "firstName": "string",
    "lastName": "string",
    "email": "string",
    "contact": { "code": "string", "number": 0 },
    "dob": "string",
    "verified": true,
    "createdAt": "string",
    "updatedAt": "string",
    "__v": 0,
    "avatar": "string",
    "isSupportUser": true,
    "unReadNotifications": ["string"],
    "status": "string",
    "loginType": "string",
    "resetPasswordTimestamps": ["string"],
    "verificationTimestamps": ["string"],
    "userPreference": "string",
    "fullName": "string",
    "age": 0,
    "canResendVerification": true,
    "canResetPassword": true,
    "provider": "string",
    "token": "string",
    "refreshToken": "string"
  }
}

Conventions

Dates in progress lists use YYYY-MM-DD.
Timestamps in assets/categories are ISO date-time strings.
Only /v1/users/signin is unauthenticated. Every other endpoint requires x-api-key.

​Authentication

​Errors

​Sign in

​Upload progress

​Get progress (list)

​Get progress by ID

​Get external asset categories (by project)

​Get external assets (by structure + category)

​Data models

​Conventions

Authentication

Errors

Sign in

Upload progress

Get progress (list)

Get progress by ID

Get external asset categories (by project)

Get external assets (by structure + category)

Data models

Conventions