Skip to content

Get Code2Des Status

Method

This API follows the REST methodology.

HTTP Method

GET: Retrieve Code2Des status

Naming Convention

Response JSON uses camelCase, matching the other PostgreSQL lifecycle endpoints.

Request and Response

Headers

Request Headers

  • Authorization
  • Accept
  • Accept-language

Response Headers

  • Content-Type

Retrieve Code2Des Status

URI

GET /api/v1/organizations/{organization_id}/projects/{project_id}/code2des/{code2des_id}

Path Parameters

Name Type Required Description
organization_id integer Required Organization ID
project_id integer Required Project ID
code2des_id string Required Code2Des UUID

Request Body

None.

Response

The response is JSON (HTTP status: 200 OK).

{
  "code2desId": "019ffa75-01c0-75a2-8123-456789abcdf0",
  "pageImportId": "019ffa75-01c0-75a2-8123-456789abcdef",
  "organizationId": 1,
  "projectId": 7,
  "figmaFileKey": "aBc123",
  "screenId": "homepage",
  "placementTarget": null,
  "status": "1",
  "attempt": 1,
  "resultUrl": "s3://bucket/1/7/code2des/019ffa75-01c0-75a2-8123-456789abcdf0/result.json",
  "warningCount": 2,
  "error": null,
  "materializedAt": null,
  "materializedNodeId": null,
  "createdAt": "2026-08-20T00:00:00.000Z",
  "updatedAt": "2026-08-20T01:00:00.000Z"
}

Response Fields

Name Type Description
code2desId string Job UUID and polling key.
pageImportId string Reusable completed Page Import used as the source.
organizationId / projectId integer Tenant scope.
figmaFileKey string Target Figma file used for plugin discovery.
screenId string Generated screen identity.
placementTarget string | null Optional initial Figma placement context.
status string "0" processing, "1" completed, or "2" failed.
attempt integer Worker-attempt fence; currently 1.
resultUrl string | null Backend artifact pointer. Clients use the result endpoint instead of reading it directly.
warningCount integer | null Deterministic conversion warning count.
error string | null Safe terminal failure detail.
materializedAt string | null First successful Figma placement timestamp.
materializedNodeId string | null First successfully created Figma root ID.
createdAt / updatedAt string Audit timestamps in ISO 8601 format.

Status Codes

Value Meaning
"0" processing
"1" completed
"2" failed

Data Source

All response fields come from the scoped, non-deleted PostgreSQL code2des row. This is the lightweight control-plane polling endpoint and does not download the generated artifact or image assets.

After this endpoint reports status: "1", use Get Code2Des Result. This is the same status/result separation used by WF2Des and Code2WF.

Authentication

Authentication uses an Amazon Cognito JWT. The caller must have Read access to the project.

Error Handling

Description Status Code Status Name
Missing authentication credentials 401 Unauthorized
Scoped, authorized, non-deleted Code2Des row not found 404 Not Found
Internal database error 500 Internal Server Error

Processing Flow

  1. Authenticate and verify Read access.
  2. Fetch the non-deleted Code2Des row by organization, project, and ID.
  3. Return lifecycle and artifact-pointer metadata without reading S3.