Coder · Example Payload

Coder Get Workspace Example

Developer ToolsRemote DevelopmentCloud Development EnvironmentsAI AgentsInfrastructureWorkspaces

Coder Get Workspace Example is an example object payload from Coder, with 26 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

idcreated_atupdated_atowner_idowner_nameowner_avatar_urlorganization_idorganization_nametemplate_idtemplate_nametemplate_display_nametemplate_icontemplate_allow_user_cancel_workspace_jobslatest_buildnameautostart_schedulettl_mslast_used_athealthdelete_afterdormant_atdeleting_atautomatic_updatesallow_renamesfavoritenext_start_at

Example Payload

{
  "id": "3f4e5c6d-7a8b-9c0d-1e2f-3a4b5c6d7e8f",
  "created_at": "2025-01-15T10:30:00Z",
  "updated_at": "2025-06-01T08:45:00Z",
  "owner_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "owner_name": "jsmith",
  "owner_avatar_url": "https://avatars.githubusercontent.com/u/12345?v=4",
  "organization_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "organization_name": "Acme Corp",
  "template_id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
  "template_name": "ubuntu-22-dev",
  "template_display_name": "Ubuntu 22.04 Dev",
  "template_icon": "/icon/ubuntu.png",
  "template_allow_user_cancel_workspace_jobs": true,
  "latest_build": {
    "id": "d4e5f6a7-b8c9-0123-def0-234567890123",
    "created_at": "2025-06-01T08:45:00Z",
    "updated_at": "2025-06-01T08:50:00Z",
    "workspace_id": "3f4e5c6d-7a8b-9c0d-1e2f-3a4b5c6d7e8f",
    "workspace_name": "my-workspace",
    "workspace_owner_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "workspace_owner_name": "jsmith",
    "template_version_id": "e5f6a7b8-c9d0-1234-ef01-345678901234",
    "template_version_name": "v1.2.0",
    "build_number": 5,
    "transition": "start",
    "initiator_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "initiator_name": "jsmith",
    "job": {
      "id": "f6a7b8c9-d0e1-2345-f012-456789012345",
      "created_at": "2025-06-01T08:45:00Z",
      "started_at": "2025-06-01T08:45:05Z",
      "completed_at": "2025-06-01T08:50:00Z",
      "canceled_at": null,
      "error": null,
      "status": "succeeded",
      "worker_id": null,
      "file_id": "a7b8c9d0-e1f2-3456-0123-567890123456",
      "tags": {
        "scope": "organization",
        "owner": ""
      }
    },
    "reason": "initiator",
    "resources": [],
    "deadline": "2025-06-02T08:45:00Z",
    "max_deadline": "2025-06-08T08:45:00Z",
    "status": "running",
    "daily_cost": 10
  },
  "name": "my-workspace",
  "autostart_schedule": "CRON_TZ=America/Chicago 0 9 * * MON-FRI",
  "ttl_ms": 28800000,
  "last_used_at": "2025-06-12T07:00:00Z",
  "health": {
    "healthy": true,
    "failing_agents": []
  },
  "delete_after": null,
  "dormant_at": null,
  "deleting_at": null,
  "automatic_updates": "never",
  "allow_renames": true,
  "favorite": false,
  "next_start_at": "2025-06-13T14:00:00Z"
}