Skip to main content
GET
/
api
/
projects
/
{id}
cURL
curl --request GET \
  --url http://localhost/api/projects/{id}
{
  "uuid": "<string>",
  "createdOn": "2023-11-07T05:31:56Z",
  "updatedOn": "2023-11-07T05:31:56Z",
  "changeSequence": 123,
  "organization": {
    "uuid": "<string>",
    "createdOn": "2023-11-07T05:31:56Z",
    "updatedOn": "2023-11-07T05:31:56Z",
    "changeSequence": 123,
    "name": "<string>",
    "slug": "<string>",
    "publicAccess": true,
    "description": "<string>",
    "organizationStatus": "ACTIVE",
    "hasImage": true,
    "defaultToPrivateTemplates": true,
    "supportAccess": true,
    "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
    "stripeCustomerId": "<string>",
    "enterpriseOrganization": true,
    "id": "<string>"
  },
  "name": "<string>",
  "description": "<string>",
  "owner": {
    "uuid": "<string>",
    "createdOn": "2023-11-07T05:31:56Z",
    "updatedOn": "2023-11-07T05:31:56Z",
    "changeSequence": 123,
    "email": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "bio": "<string>",
    "userStorage": {
      "favoriteLinks": [
        {
          "link": "<string>"
        }
      ]
    },
    "showDeveloperTools": true,
    "image": "<string>",
    "userHash": "<string>",
    "acceptedTerms": true,
    "userType": "HUMAN",
    "active": true,
    "fullName": "<string>",
    "externallyManaged": true,
    "hasAcceptedTerms": true,
    "id": "<string>",
    "security": {
      "roles": [
        "PLATFORM_ADMIN"
      ]
    },
    "preferences": {
      "showWelcomeMessage": true,
      "showOnboarding": true,
      "showScrollbars": true
    }
  },
  "status": {
    "uuid": "<string>",
    "createdOn": "2023-11-07T05:31:56Z",
    "updatedOn": "2023-11-07T05:31:56Z",
    "changeSequence": 123,
    "organization": {
      "uuid": "<string>",
      "createdOn": "2023-11-07T05:31:56Z",
      "updatedOn": "2023-11-07T05:31:56Z",
      "changeSequence": 123,
      "name": "<string>",
      "slug": "<string>",
      "publicAccess": true,
      "description": "<string>",
      "organizationStatus": "ACTIVE",
      "hasImage": true,
      "defaultToPrivateTemplates": true,
      "supportAccess": true,
      "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
      "stripeCustomerId": "<string>",
      "enterpriseOrganization": true,
      "id": "<string>"
    },
    "color": "<string>",
    "icon": "<string>",
    "status": "<string>",
    "production": true,
    "id": "<string>"
  },
  "templateArticleId": "<string>",
  "projectTemplateRef": "<string>",
  "notes": "<string>",
  "color": "<string>",
  "tags": [
    {
      "uuid": "<string>",
      "createdOn": "2023-11-07T05:31:56Z",
      "updatedOn": "2023-11-07T05:31:56Z",
      "changeSequence": 123,
      "organization": {
        "uuid": "<string>",
        "createdOn": "2023-11-07T05:31:56Z",
        "updatedOn": "2023-11-07T05:31:56Z",
        "changeSequence": 123,
        "name": "<string>",
        "slug": "<string>",
        "publicAccess": true,
        "description": "<string>",
        "organizationStatus": "ACTIVE",
        "hasImage": true,
        "defaultToPrivateTemplates": true,
        "supportAccess": true,
        "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
        "stripeCustomerId": "<string>",
        "enterpriseOrganization": true,
        "id": "<string>"
      },
      "name": "<string>",
      "color": "<string>",
      "id": "<string>"
    }
  ],
  "dataFlow": {
    "viewPort": {
      "x": 123,
      "y": 123,
      "zoom": 123
    },
    "nodes": [
      {
        "id": "<string>",
        "parentId": "<string>",
        "type": "<string>",
        "position": {
          "x": 123,
          "y": 123
        },
        "dimensions": {
          "width": 123,
          "height": 123
        },
        "properties": {}
      }
    ],
    "edges": [
      {
        "id": "<string>",
        "source": "<string>",
        "target": "<string>",
        "properties": {}
      }
    ]
  },
  "options": {
    "options": [
      {
        "groupOptions": [
          {}
        ],
        "properties": {},
        "tabName": "<string>",
        "name": "<string>",
        "aliases": [
          "<string>"
        ],
        "label": "<string>",
        "falseLabel": "<string>",
        "hint": "<string>",
        "required": true,
        "type": "<string>",
        "subType": "<string>",
        "listType": "<string>",
        "displayProperties": {},
        "listLabel": "<string>",
        "listDescription": "<string>",
        "featureFlag": "<string>",
        "default": {},
        "description": "<string>",
        "supportArticle": "<string>",
        "overviewMarkdown": "<string>",
        "showIf": "<string>",
        "developerOnly": true,
        "showOnPopup": true,
        "possibleValues": [
          {
            "label": "<string>",
            "value": {},
            "description": "<string>"
          }
        ]
      }
    ],
    "properties": {},
    "groupTaxonTypeFeatures": {},
    "taxonTypeFeatures": {},
    "taskOptions": {
      "showTakeNext": true,
      "showNewTask": true
    }
  },
  "documentStatuses": [
    {
      "uuid": "<string>",
      "createdOn": "2023-11-07T05:31:56Z",
      "updatedOn": "2023-11-07T05:31:56Z",
      "changeSequence": 123,
      "color": "<string>",
      "icon": "<string>",
      "status": "<string>",
      "slug": "<string>",
      "statusType": "UNRESOLVED",
      "id": "<string>"
    }
  ],
  "statusType": "ACTIVE",
  "taskStatuses": [
    {
      "uuid": "<string>",
      "createdOn": "2023-11-07T05:31:56Z",
      "updatedOn": "2023-11-07T05:31:56Z",
      "changeSequence": 123,
      "color": "<string>",
      "icon": "<string>",
      "label": "<string>",
      "slug": "<string>",
      "statusType": "TODO",
      "id": "<string>"
    }
  ],
  "id": "<string>"
}

Path Parameters

id
string
required

Response

OK

name
string
required
uuid
string

The UUID of the object

createdOn
string<date-time>
updatedOn
string<date-time>
changeSequence
integer

The change sequence of the object, which can be used to track modications

organization
object
description
string
owner
object

A user of the Kodexa Platform

status
object

The project status

templateArticleId
string
projectTemplateRef
string
notes
string
color
string
tags
object[]

The project tags related to this project

dataFlow
object
options
object

Options for the project template

documentStatuses
object[]
statusType
enum<string>

The project status type (ACTIVE or ARCHIVED)

Available options:
ACTIVE,
ARCHIVED
taskStatuses
object[]
id
string

The ID of the object

I