Skip to main content
GET
/
api
/
projects
List Projects
curl --request GET \
  --url https://platform.kodexa.ai/api/projects \
  --header 'x-api-key: <api-key>'
{
  "content": [
    {
      "changeSequence": 123,
      "color": "#4A90D9",
      "createdOn": "2023-11-07T05:31:56Z",
      "dataFlow": {
        "edges": [
          {
            "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
            "properties": {},
            "source": "<string>",
            "target": "<string>"
          }
        ],
        "nodes": [
          {
            "dimensions": {
              "height": 123,
              "width": 123
            },
            "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
            "parentId": "<string>",
            "position": {
              "x": 123,
              "y": 123
            },
            "properties": {},
            "type": "<string>"
          }
        ],
        "viewPort": {
          "x": 123,
          "y": 123,
          "zoom": 123
        }
      },
      "description": "Automated invoice processing pipeline.",
      "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "memory": {
        "changeSequence": 123,
        "orderedDashboards": [
          "<string>"
        ],
        "recentFilters": {},
        "recentQueries": {}
      },
      "name": "Invoice Processing",
      "notes": "<string>",
      "options": {
        "dataOptions": [
          {
            "aliases": [
              "<string>"
            ],
            "default": {},
            "description": "Automated invoice processing pipeline.",
            "developerOnly": true,
            "displayProperties": {},
            "falseLabel": "<string>",
            "featureFlag": "<string>",
            "groupOptions": [
              {}
            ],
            "hint": "<string>",
            "label": "<string>",
            "listDescription": "<string>",
            "listLabel": "<string>",
            "listType": "<string>",
            "name": "Invoice Processing",
            "overviewMarkdown": "<string>",
            "possibleValues": [
              {
                "description": "Automated invoice processing pipeline.",
                "label": "<string>",
                "value": {}
              }
            ],
            "properties": {},
            "required": true,
            "showIf": "<string>",
            "showOnPopup": true,
            "subType": "<string>",
            "supportArticle": "<string>",
            "tabName": "<string>",
            "type": "<string>"
          }
        ],
        "dataProperties": {},
        "groupTaxonTypeFeatures": {},
        "options": [
          {
            "aliases": [
              "<string>"
            ],
            "default": {},
            "description": "Automated invoice processing pipeline.",
            "developerOnly": true,
            "displayProperties": {},
            "falseLabel": "<string>",
            "featureFlag": "<string>",
            "groupOptions": [
              {}
            ],
            "hint": "<string>",
            "label": "<string>",
            "listDescription": "<string>",
            "listLabel": "<string>",
            "listType": "<string>",
            "name": "Invoice Processing",
            "overviewMarkdown": "<string>",
            "possibleValues": [
              {
                "description": "Automated invoice processing pipeline.",
                "label": "<string>",
                "value": {}
              }
            ],
            "properties": {},
            "required": true,
            "showIf": "<string>",
            "showOnPopup": true,
            "subType": "<string>",
            "supportArticle": "<string>",
            "tabName": "<string>",
            "type": "<string>"
          }
        ],
        "properties": {},
        "taskOptions": {
          "showNewTask": true,
          "showTakeNext": true
        },
        "taxonTypeFeatures": {}
      },
      "organization": {
        "authGroupLink": {
          "authGroup": "<string>"
        },
        "changeSequence": 123,
        "createdOn": "2023-11-07T05:31:56Z",
        "defaultToPrivateTemplates": true,
        "description": "Automated invoice processing pipeline.",
        "enterpriseOrganization": true,
        "features": {},
        "hasImage": true,
        "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
        "memory": {
          "orderedDashboards": [
            "<string>"
          ]
        },
        "name": "Invoice Processing",
        "organizationStatus": "<string>",
        "properties": {},
        "publicAccess": true,
        "searchText": "<string>",
        "slug": "invoice-processing",
        "stripeCustomerId": "<string>",
        "supportAccess": true,
        "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
        "updatedOn": "2023-11-07T05:31:56Z",
        "uuid": "7c9e667974254de944be07fc1f90ae7"
      },
      "organizationId": "<string>",
      "owner": {
        "active": true,
        "bio": "<string>",
        "businessGroup": "<string>",
        "changeSequence": 123,
        "createdOn": "2023-11-07T05:31:56Z",
        "email": "<string>",
        "firstName": "<string>",
        "groupsJson": "<string>",
        "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
        "image": "<string>",
        "isExternallyManaged": true,
        "lastName": "<string>",
        "preferences": {
          "showOnboarding": true,
          "showScrollbars": true,
          "showWelcomeMessage": true
        },
        "roles": {
          "roles": [
            "<string>"
          ]
        },
        "rolesJson": "<string>",
        "searchText": "<string>",
        "showDeveloperTools": true,
        "title": "<string>",
        "updatedOn": "2023-11-07T05:31:56Z",
        "userStorage": {
          "favoriteLinks": [
            {
              "link": "<string>"
            }
          ]
        },
        "userType": "<string>",
        "uuid": "7c9e667974254de944be07fc1f90ae7"
      },
      "ownerId": "<string>",
      "projectTemplateRef": "<string>",
      "searchText": "<string>",
      "slug": "invoice-processing",
      "status": {
        "changeSequence": 123,
        "color": "#4A90D9",
        "createdOn": "2023-11-07T05:31:56Z",
        "icon": "<string>",
        "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
        "organization": {
          "authGroupLink": {
            "authGroup": "<string>"
          },
          "changeSequence": 123,
          "createdOn": "2023-11-07T05:31:56Z",
          "defaultToPrivateTemplates": true,
          "description": "Automated invoice processing pipeline.",
          "enterpriseOrganization": true,
          "features": {},
          "hasImage": true,
          "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
          "memory": {
            "orderedDashboards": [
              "<string>"
            ]
          },
          "name": "Invoice Processing",
          "organizationStatus": "<string>",
          "properties": {},
          "publicAccess": true,
          "searchText": "<string>",
          "slug": "invoice-processing",
          "stripeCustomerId": "<string>",
          "supportAccess": true,
          "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
          "updatedOn": "2023-11-07T05:31:56Z",
          "uuid": "7c9e667974254de944be07fc1f90ae7"
        },
        "organizationId": "<string>",
        "production": true,
        "status": "<string>",
        "updatedOn": "2023-11-07T05:31:56Z",
        "uuid": "7c9e667974254de944be07fc1f90ae7"
      },
      "statusId": "<string>",
      "statusType": "ACTIVE",
      "templateArticleId": "<string>",
      "updatedOn": "2023-11-07T05:31:56Z",
      "uuid": "7c9e667974254de944be07fc1f90ae7"
    }
  ],
  "first": true,
  "last": true,
  "number": 123,
  "numberOfElements": 123,
  "pageable": {
    "offset": 123,
    "pageNumber": 123,
    "pageSize": 123,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 123,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 123,
  "totalPages": 123
}

Authorizations

​
x-api-key
string
header
required

API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.

Query Parameters

​
page
integer<int32>

Page number (1-indexed). Defaults to 1.

​
pageSize
integer<int32>

Number of items per page (1-1000). Defaults to 20, maximum 1000.

​
sort
string

Sort expression as field,direction. Direction is asc or desc. Multiple sort fields can be specified by repeating the parameter.

​
filter
string

RSQL/FIQL filter expression. Supported operators: == (equals), != (not equals), =like= (contains), =in= (in list), > / >= / < / <= (comparison), =isnull=true (is null), =isnull=false (is not null). Combine with ; (AND) or , (OR). Example: name=='Acme Corp';status==active

​
query
string

Full-text search query matching against the entity's searchable fields.

Response

Page of Project

Paginated response containing Project items.

​
content
object[]

Array of Project items on this page.

​
first
boolean

Whether this is the first page.

​
last
boolean

Whether this is the last page.

​
number
integer<int32>

Current page number (0-indexed).

​
numberOfElements
integer<int32>

Number of items on the current page.

​
pageable
object

Pagination metadata.

​
size
integer<int32>

Page size (number of items per page).

​
sort
object

Sort metadata.

​
totalElements
integer<int64>

Total number of items across all pages.

​
totalPages
integer<int32>

Total number of pages.