Skip to main content

Endpoint

Request

Read endpoints return the resource object directly. There is no wrapper field.

Response

string
required
Unique project ID (proj_ prefix)
string
required
Short ID for display (PID- prefix)
string
required
ID of the user who owns the project (user_ prefix)
string
required
Project name
string | null
Project description
string
required
Project status. Returned in lowercase (for example trial)
string | null
Trial expiry time (ISO 8601). null when the project is not on trial
number
required
Number of workflows in this project
object[]
required
Workflows attached to this project
number
required
Number of issued API keys
number
required
Number of project members
object
required
Project owner information
string
required
Creation time (ISO 8601)
string
required
Last update time (ISO 8601)

workflows[]

Use GET /workflows/:workflowId for the full definition.

owner


Example response

The example below is fictional and exists to illustrate the structure.