Get User Build Status

GET 
/api/build-status

This endpoint retrieves the build status of a user's odyssey based on their user ID. The request must include a valid API key and user ID in the headers.

Request

Header Parameters

x-api-key stringrequired

API key to authorize the request.

userid stringrequired

ID of the user whose status is being retrieved.

Responses

200

Successfully retrieved user build status.

application/json

Schema

Schema

status string

The current build status of the user's odyssey.

createdAt date-time

The timestamp when the status was created.

workspaceId string

The ID of the workspace associated with the user's odyssey.

Example (from schema)

{
  "status": "string",
  "createdAt": "2024-08-08T13:41:56.764Z",
  "workspaceId": "string"
}

400

Status not set.

application/json

Schema

Schema

message string

Error message indicating that the status is not set.

Example (from schema)

{
  "message": "string"
}

403

Invalid API key or user is not authorized.

application/json

Schema

Schema

error

object

message string

Detailed error message.

Example (from schema)

{
  "error": {
    "message": "string"
  }
}

404

User not found.

application/json

Schema

Schema

error

object

message string

Error message indicating that the user was not found.

Example (from schema)

{
  "error": {
    "message": "string"
  }
}

500

Internal server error.

application/json

Schema

Schema

message string

Error message indicating an internal server error.

Example (from schema)

{
  "message": "string"
}

Loading...