View Workflows

Retrieve existing workflows available in your account.

Endpoint


GET https://api.smart-kyc.com/api/manager/external/workflows?page=<page number>&size=<page size>

Request Headers


accept: application/json
Authorization: Bearer ACCESS_TOKEN

Parameters:

ACCESS_TOKEN: Retrieved from authentication endpoint
page (query parameter): Page number (optional)
size (query parameter): Page size (optional)

Example Request


curl -X 'GET' \
  'https://api.smart-kyc.com/api/manager/external/workflows?page=0&size=10' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer ACCESS_TOKEN'

Response

200 OK


{
  "content": [
    {
      "id": "9bf9545c-d7a7-4f67-ae6b-ebaf4379d623",
      "name": "Basic Company"
    },
    {
      "id": "9ff9668b-460b-45bc-a5cf-6f537101e457",
      "name": "Basic Individual"
    }
  ],
  "pageable": {
    "pageNumber": 0,
    "pageSize": 10,
    "sort": {
      "sorted": false,
      "empty": true,
      "unsorted": true
    },
    "offset": 0,
    "paged": true,
    "unpaged": false
  },
  "last": true,
  "totalPages": 1,
  "totalElements": 2,
  "first": true,
  "size": 10,
  "number": 0,
  "sort": {
    "sorted": false,
    "empty": true,
    "unsorted": true
  },
  "numberOfElements": 2,
  "empty": false
}

Workflow data are present in the content list. Use the id field to reference workflows in other API calls, such as sending invitations.

404 Not Found


{
  "type": "about:blank",
  "title": "KnownRuntimeError",
  "status": 404,
  "detail": "Account not found",
  "instance": "/api/manager/external/workflows",
  "timestamp": 1768492024086,
  "full-path": "https://api.smart-kyc.com/api/manager/external/workflows"
}