Custom Workflow

These endpoints let you manage custom workflows in the system.

Get Workflow Activities

get

Search Query

Supported Keys

Supported Operators

Notes

:

Equal operator

effectiveDate

> <

Greater than or equal to Less than or equal to

employee.id

:

Equal operator

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

application/json

totalPagesintegerRequired

Total number of pages available

lastbooleanRequired

Indicates whether this is the last page

totalElementsintegerRequired

Total number of elements across all pages

numberOfElementsintegerRequired

Number of elements in the current page

firstbooleanRequired

Indicates whether this is the first page

sizeintegerRequired

Size of the page (number of elements per page)

numberintegerRequired

Current page number (zero-indexed)

400

Bad Request

get

/core/v1/workflow-activities

curl -X GET \
  "https://api.catapa.com/core/v1/workflow-activities" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "content": [
    {
      "id": "61dfe777-f9ea-4a50-b075-734cb62ed20e",
      "createdDate": 1750272376000,
      "updatedDate": 1750272376000,
      "workflowTemplate": {
        "id": "338c1570-a57e-4153-aec7-b7c7446c964c",
        "name": "Organizational Change",
        "type": "PERSONNEL",
        "context": "employee"
      },
      "effectiveDate": "2020-01-01",
      "workflowReason": {
        "id": "fe0b217f-dd55-426a-b987-9a618ca794fe",
        "createdDate": 1609459200000,
        "updatedDate": 1609459200000,
        "code": "HIRING-SDE",
        "name": "New Hire Software Development Engineer",
        "category": {
          "id": "f8c6557f-d265-46d7-b496-ae3d666a93ed",
          "code": "HIRING",
          "name": "Hiring",
          "restrictDuplicateEffectiveDate": false
        }
      },
      "employee": {
        "id": "b2eb7e97-b0a3-405a-951e-7b0acf099f27",
        "identificationNumber": "ID-00010001",
        "name": "Hendra Jaya"
      }
    }
  ],
  "totalPages": 1,
  "totalElements": 1,
  "numberOfElements": 1,
  "size": 10,
  "number": 0,
  "first": true,
  "last": true,
  "sort": [
    {
      "direction": "ASC",
      "property": "id"
    }
  ]
}

Get Workflow Reasons

get

Search Query

Supported Keys

Supported Operators

Notes

code

:

Like operator

name

:

Like operator

category.id

:

Equal operator

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

application/json

totalPagesintegerRequired

Total number of pages available

lastbooleanRequired

Indicates whether this is the last page

totalElementsintegerRequired

Total number of elements across all pages

numberOfElementsintegerRequired

Number of elements in the current page

firstbooleanRequired

Indicates whether this is the first page

sizeintegerRequired

Size of the page (number of elements per page)

numberintegerRequired

Current page number (zero-indexed)

400

Bad Request

get

/core/v1/workflow-reasons

curl -X GET \
  "https://api.catapa.com/core/v1/workflow-reasons" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "content": [
    {
      "id": "79f537af-83b2-4a8b-851c-5d14ec046554",
      "createdDate": 1609459200000,
      "updatedDate": 1609459200000,
      "code": "PROM-01",
      "name": "Promotion to Senior",
      "category": {
        "id": "60a2d8c2-b5ff-11e6-80f5-76304dec7eb1",
        "code": "PROMOTION",
        "name": "Promotion"
      }
    },
    {
      "id": "fe0b217f-dd55-426a-b987-9a618ca794fe",
      "code": "HIRING-SDE",
      "name": "New Hire Software Development Engineer",
      "category": {
        "id": "f8c6557f-d265-46d7-b496-ae3d666a93ed",
        "code": "HIRING",
        "name": "Hiring",
        "restrictDuplicateEffectiveDate": false
      }
    }
  ],
  "pageable": "INSTANCE",
  "number": 0,
  "size": 10,
  "totalPages": 1,
  "numberOfElements": 2,
  "totalElements": 2,
  "last": true,
  "sort": [],
  "first": true,
  "empty": true
}

Create Workflow Reason

post

Create a workflow reason.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

codestring · min: 1 · max: 255Required

namestring · min: 1 · max: 255Required

Responses

201

application/json

400

Bad Request

post

/core/v1/workflow-reasons

curl -X POST \
  "https://api.catapa.com/core/v1/workflow-reasons" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id" \
  -H "Content-Type: application/json" \
  -d '{
  "code": "PROM-02",
  "name": "Promotion to Principal",
  "category": {
    "id": "60a2d8c2-b5ff-11e6-80f5-76304dec7eb1"
  }
}'

{
  "id": "02bcd3f5-a07b-4f6c-88aa-5474a604ba56",
  "createdDate": 1609459200000,
  "updatedDate": 1609459200000,
  "code": "PROM-02",
  "name": "Promotion to Principal",
  "category": {
    "id": "60a2d8c2-b5ff-11e6-80f5-76304dec7eb1",
    "code": "PROMOTION",
    "name": "Promotion",
    "restrictDuplicateEffectiveDate": false
  }
}

Update Workflow Reason

put

Update the workflow reason.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequiredExample: f47ac10b-58cc-4372-a567-0e02b2c3d479

Body

codestring · min: 1 · max: 255Required

namestring · min: 1 · max: 255Required

Responses

200

application/json

idstringOptional

createdDatenumberOptional

updatedDatenumberOptional

codestringOptional

namestringOptional

400

Bad Request

put

/core/v1/workflow-reasons/{id}

curl -X PUT \
  "https://api.catapa.com/core/v1/workflow-reasons/f47ac10b-58cc-4372-a567-0e02b2c3d479" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id" \
  -H "Content-Type: application/json" \
  -d '{
  "code": "PROM-02",
  "name": "Promotion to Principal",
  "category": {
    "id": "60a2d8c2-b5ff-11e6-80f5-76304dec7eb1"
  }
}'

{
  "id": "02bcd3f5-a07b-4f6c-88aa-5474a604ba56",
  "createdDate": 1609459200000,
  "updatedDate": 1609459200000,
  "code": "PROM-02",
  "name": "Promotion to Principal",
  "category": {
    "id": "60a2d8c2-b5ff-11e6-80f5-76304dec7eb1",
    "code": "PROMOTION",
    "name": "Promotion",
    "restrictDuplicateEffectiveDate": false
  }
}

Get Workflow Reason Categories

get

Search Query

Supported Keys

Supported Operators

Notes

code

:

Like operator

name

:

Like operator

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

application/json

totalPagesintegerRequired

Total number of pages available

lastbooleanRequired

Indicates whether this is the last page

totalElementsintegerRequired

Total number of elements across all pages

numberOfElementsintegerRequired

Number of elements in the current page

firstbooleanRequired

Indicates whether this is the first page

sizeintegerRequired

Size of the page (number of elements per page)

numberintegerRequired

Current page number (zero-indexed)

400

Bad Request

get

/core/v1/workflow-reason-categories

curl -X GET \
  "https://api.catapa.com/core/v1/workflow-reason-categories" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "content": [
    {
      "id": "60a2d8c2-b5ff-11e6-80f5-76304dec7eb1",
      "code": "PROMOTION",
      "name": "Promotion",
      "restrictDuplicateEffectiveDate": true
    },
    {
      "id": "f8c6557f-d265-46d7-b496-ae3d666a93ed",
      "code": "HIRING",
      "name": "Hiring",
      "restrictDuplicateEffectiveDate": false
    }
  ],
  "pageable": "INSTANCE",
  "number": 0,
  "size": 10,
  "totalPages": 1,
  "numberOfElements": 2,
  "totalElements": 2,
  "last": true,
  "sort": [],
  "first": true,
  "empty": true
}

Create Workflow Reason Category

post

Create a workflow reason category.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

codestring · min: 1 · max: 255Required

namestring · min: 1 · max: 255Required

Responses

201

application/json

400

Bad Request

post

/core/v1/workflow-reason-categories

curl -X POST \
  "https://api.catapa.com/core/v1/workflow-reason-categories" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id" \
  -H "Content-Type: application/json" \
  -d '{
  "code": "TERMINATION",
  "name": "Termination"
}'

{
  "id": "02bcd3f5-a07b-4f6c-88aa-5474a604ba56",
  "code": "TERMINATION",
  "name": "Termination",
  "restrictDuplicateEffectiveDate": false
}

Update Workflow Reason Category

put

Update the workflow reason category.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequiredExample: f47ac10b-58cc-4372-a567-0e02b2c3d479

Body

codestring · min: 1 · max: 255Required

namestring · min: 1 · max: 255Required

Responses

200

application/json

idstringOptional

codestringOptional

namestringOptional

restrictDuplicateEffectiveDatebooleanOptional

400

Bad Request

put

/core/v1/workflow-reason-categories/{id}

curl -X PUT \
  "https://api.catapa.com/core/v1/workflow-reason-categories/f47ac10b-58cc-4372-a567-0e02b2c3d479" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id" \
  -H "Content-Type: application/json" \
  -d '{
  "code": "PROMOTION",
  "name": "Promotion / Mutation"
}'

{
  "id": "60a2d8c2-b5ff-11e6-80f5-76304dec7eb1",
  "code": "PROMOTION",
  "name": "Promotion / Mutation",
  "restrictDuplicateEffectiveDate": false
}

Last updated 16 days ago

hashtagGet Workflow Activities

hashtagSearch Query

hashtagGet Workflow Reasons

hashtagSearch Query

hashtagCreate Workflow Reason

hashtagUpdate Workflow Reason

hashtagGet Workflow Reason Categories

hashtagSearch Query

hashtagCreate Workflow Reason Category

hashtagUpdate Workflow Reason Category

Get Workflow Activities

Search Query

Get Workflow Reasons

Search Query

Create Workflow Reason

Update Workflow Reason

Get Workflow Reason Categories

Search Query

Create Workflow Reason Category

Update Workflow Reason Category