Organization

These endpoints let you manage organizations in the system. It allows you to retrieve, create, update, and delete organization records.

Get Company

get

Return the current tenant's company.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

application/json

idstringOptional

namestringOptional

codestringOptional

websitestringOptional

siupstringOptional

tdpstringOptional

logostringOptional

logoOriginalFilenamestringOptional

emailstringOptional

400

Bad Request

get

/core/v1/companies

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

{
  "id": "b6be6665-9907-4585-af8b-944a475fc8e2",
  "name": "Company Name",
  "code": "Company Name",
  "website": "http://www.company.com",
  "siup": "SIUP/123/000-67.8",
  "tdp": "TDP/123/000-67.8",
  "logo": "company/b6be6665-9907-4585-af8b-944a475fc8e2.png",
  "logoOriginalFilename": "catapa.png",
  "logoFileMetadata": {
    "filename": "catapa.png",
    "path": "company/b6be6665-9907-4585-af8b-944a475fc8e2.png",
    "url": "https://www.company.com/logo.png"
  },
  "timeZone": {
    "code": "Asia/Jakarta",
    "offset": "+07:00"
  },
  "email": "company@example.com",
  "companySuperior": {
    "id": "0332e2b1-ba56-4a33-9d8a-6e66a4acde21",
    "name": "blebelbelbelbel",
    "code": "blebelbelbelbel",
    "website": "www.companysuperior.com",
    "siup": "",
    "tdp": "",
    "logo": "company/0332e2b1-ba56-4a33-9d8a-6e66a4acde21.png",
    "logoOriginalFilename": "catapa.png",
    "logoFileMetadata": {
      "filename": "catapa.png",
      "path": "company/0332e2b1-ba56-4a33-9d8a-6e66a4acde21.png",
      "url": "https://example.com/logo.png"
    },
    "timeZone": {
      "code": "Universal",
      "offset": "+00:00"
    },
    "email": "superior@example.com",
    "location": {
      "id": "a31aa166-70be-4303-81e4-5ada93b5213a",
      "code": "JOG",
      "name": "Yogyakarta",
      "locationGroup": {
        "id": "12345678-1234-1234-1234-123456789012",
        "code": "GRP01",
        "name": "Group 1"
      },
      "city": {
        "id": "2d1ecc14-a6ea-11e6-80f5-76304dec7eb7",
        "code": "34.71",
        "name": "Kota Yogyakarta",
        "state": {
          "id": "71f5a5fc-a699-11e6-80f5-76304dec7eb7",
          "name": "Special Region Yogyakarta",
          "code": "34",
          "country": {
            "id": "d1eac40e-a691-11e6-80f5-76304dec7eb7",
            "code": "IDN",
            "callingCode": "+62",
            "name": "Indonesia",
            "taxTreaty": false
          }
        }
      },
      "latitude": -7.72087,
      "longitude": 110.35946,
      "address": "Jl. Turgo No.1, Beran, Tridadi, Daerah Istimewa Yogyakarta 63352, Indonesia",
      "phone": "+628123456789",
      "zipCode": "60123",
      "headquarter": false,
      "company": {
        "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb7",
        "code": "COMP-001",
        "name": "PT. CATAPA"
      },
      "effectiveDate": "2023-01-01",
      "endDate": "9999-12-31"
    }
  },
  "location": {
    "id": "a31aa166-70be-4303-81e4-5ada93b5213a",
    "code": "JOG",
    "name": "Yogyakarta",
    "locationGroup": {
      "id": "12345678-1234-1234-1234-123456789012",
      "code": "GRP01",
      "name": "Group 1"
    },
    "city": {
      "id": "2d1ecc14-a6ea-11e6-80f5-76304dec7eb7",
      "code": "34.71",
      "name": "Kota Yogyakarta",
      "state": {
        "id": "71f5a5fc-a699-11e6-80f5-76304dec7eb7",
        "name": "Special Region Yogyakarta",
        "code": "34",
        "country": {
          "id": "d1eac40e-a691-11e6-80f5-76304dec7eb7",
          "code": "IDN",
          "callingCode": "+62",
          "name": "Indonesia",
          "taxTreaty": false
        }
      }
    },
    "latitude": -7.72087,
    "longitude": 110.35946,
    "address": "Jl. Turgo No.1, Beran, Tridadi, Daerah Istimewa Yogyakarta 63352, Indonesia",
    "phone": "+628123456789",
    "zipCode": "60123",
    "headquarter": false,
    "company": {
      "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb7",
      "code": "COMP-001",
      "name": "PT. CATAPA"
    },
    "effectiveDate": "2023-01-01",
    "endDate": "9999-12-31"
  },
  "companyGroup": {
    "id": "045c6624-ea38-4b12-8827-e3197659b656",
    "code": "CG-1",
    "name": "Company Group 1"
  }
}

Create Company

post

Create a new company. Send company data and optional logo as multipart/form-data.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

filestring · binaryOptional

Upload the company logo. Allowed file types: jpg, jpeg, png, and svg. The Content-Type must be image/jpeg, image/png, or image/svg+xml. The maximum file size is 4MB.

Responses

201

application/json

400

Bad Request

post

/core/v1/companies

curl -X POST \
  "https://api.catapa.com/core/v1/companies" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id" \
  -F 'request={"name": "Company Name", "code": "Company Name", "website": "http://www.company.com", "siup": "SIUP/123/000-67.8", "tdp": "TDP/123/000-67.8", "timeZone": {"code": "Asia/Jakarta", "offset": "+07:00"}, "email": "company@example.com", "companySuperior": {"id": "0332e2b1-ba56-4a33-9d8a-6e66a4acde21"}, "location": {"id": "a31aa166-70be-4303-81e4-5ada93b5213a"}};type=application/json' \
  -F 'file=@catapa.png'

{
  "id": "b6be6665-9907-4585-af8b-944a475fc8e2",
  "name": "Company Name",
  "code": "Company Name",
  "website": "http://www.company.com",
  "siup": "SIUP/123/000-67.8",
  "tdp": "TDP/123/000-67.8",
  "logo": "company/b6be6665-9907-4585-af8b-944a475fc8e2.png",
  "logoOriginalFilename": "catapa.png",
  "logoFileMetadata": {
    "filename": "catapa.png",
    "path": "company/b6be6665-9907-4585-af8b-944a475fc8e2.png",
    "url": "https://example.com/logo.png"
  },
  "timeZone": {
    "code": "Asia/Jakarta",
    "offset": "+07:00"
  },
  "email": "company@example.com",
  "companySuperior": {
    "id": "0332e2b1-ba56-4a33-9d8a-6e66a4acde21",
    "name": "Company Superior Name",
    "code": "Company Superior Code",
    "website": "",
    "siup": "",
    "tdp": "",
    "logo": "company/0332e2b1-ba56-4a33-9d8a-6e66a4acde21.png",
    "logoOriginalFilename": "catapa.png",
    "logoFileMetadata": {
      "filename": "catapa.png",
      "path": "company/0332e2b1-ba56-4a33-9d8a-6e66a4acde21.png",
      "url": "https://example.com/logo.png"
    },
    "timeZone": {
      "code": "Universal",
      "offset": "+00:00"
    },
    "email": "superior@example.com",
    "location": {
      "id": "a31aa166-70be-4303-81e4-5ada93b5213a",
      "code": "JOG",
      "name": "Yogyakarta",
      "locationGroup": {
        "id": "12345678-1234-1234-1234-123456789012",
        "code": "GRP01",
        "name": "Group 1"
      },
      "city": {
        "id": "2d1ecc14-a6ea-11e6-80f5-76304dec7eb7",
        "code": "34.71",
        "name": "Kota Yogyakarta",
        "state": {
          "id": "71f5a5fc-a699-11e6-80f5-76304dec7eb7",
          "name": "Special Region Yogyakarta",
          "code": "34",
          "country": {
            "id": "d1eac40e-a691-11e6-80f5-76304dec7eb7",
            "code": "IDN",
            "callingCode": "+62",
            "name": "Indonesia",
            "taxTreaty": false
          }
        }
      },
      "latitude": -7.72087,
      "longitude": 110.35946,
      "address": "Jl. Turgo No.1, Beran, Tridadi, Daerah Istimewa Yogyakarta 63352, Indonesia",
      "phone": "+628123456789",
      "zipCode": "60123",
      "headquarter": false,
      "company": {
        "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb7",
        "code": "COMP-001",
        "name": "PT. CATAPA"
      },
      "effectiveDate": "2023-01-01",
      "endDate": "9999-12-31"
    }
  },
  "location": {
    "id": "a31aa166-70be-4303-81e4-5ada93b5213a",
    "code": "JOG",
    "name": "Yogyakarta",
    "locationGroup": {
      "id": "12345678-1234-1234-1234-123456789012",
      "code": "GRP01",
      "name": "Group 1"
    },
    "city": {
      "id": "2d1ecc14-a6ea-11e6-80f5-76304dec7eb7",
      "code": "34.71",
      "name": "Kota Yogyakarta",
      "state": {
        "id": "71f5a5fc-a699-11e6-80f5-76304dec7eb7",
        "name": "Special Region Yogyakarta",
        "code": "34",
        "country": {
          "id": "d1eac40e-a691-11e6-80f5-76304dec7eb7",
          "code": "IDN",
          "callingCode": "+62",
          "name": "Indonesia",
          "taxTreaty": false
        }
      }
    },
    "latitude": -7.72087,
    "longitude": 110.35946,
    "address": "Jl. Turgo No.1, Beran, Tridadi, Daerah Istimewa Yogyakarta 63352, Indonesia",
    "phone": "+628123456789",
    "zipCode": "60123",
    "headquarter": false,
    "company": {
      "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb7",
      "code": "COMP-001",
      "name": "PT. CATAPA"
    },
    "effectiveDate": "2023-01-01",
    "endDate": "9999-12-31"
  }
}

Get Company Groups

get

Return the company groups.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pageintegerOptional

Page number

Default: 0Example: 0

sizeinteger · min: 1 · max: 50Optional

Page size

Default: 10Example: 10

querystringOptional

Search Query

Supported Keys	Supported Operators	Notes
code	`:`	Like operator
name	`:`	Like operator

Example: {"summary":"Search a company group by code","value":"code:CG-1"}

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/company-groups

curl -X GET \
  "https://api.catapa.com/core/v1/company-groups?page=0&size=10&query=code%3ACG-1" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "content": [
    {
      "id": "a31aa166-70be-4303-81e4-5ada93b5213a",
      "code": "CG-1",
      "name": "Company Group 1"
    },
    {
      "id": "f4eaf74f-3e63-414f-b7be-54c46902407f",
      "code": "CG-2",
      "name": "Company Group 2"
    }
  ],
  "totalPages": 1,
  "last": true,
  "totalElements": 2,
  "numberOfElements": 2,
  "sort": [
    {
      "direction": "ASC",
      "property": "name",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": true,
      "descending": false
    }
  ],
  "first": true,
  "size": 10,
  "number": 0
}

Get Cost Center

get

Return the cost centers.

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/cost-centers

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

{
  "content": [
    {
      "id": "840d6569-97aa-4a9a-be38-e808a39b0832",
      "code": "CC1",
      "name": "CC API 1",
      "description": "Isn't it a great cost center?",
      "company": {
        "id": "12345678-1234-1234-1234-123456789012",
        "code": "COMP-001",
        "name": "Company Name"
      }
    },
    {
      "id": "37a119e0-9b5c-4f5a-829c-cb27fe65a410",
      "code": "CC3",
      "name": "CC API 3",
      "description": "10 Bayfront Ave, Singapore 018956",
      "company": {
        "id": "12345678-1234-1234-1234-123456789012",
        "code": "COMP-001",
        "name": "Company Name"
      }
    },
    {
      "id": "2c0821e2-9c15-4626-a4c1-9e3ee380c100",
      "code": "CC2",
      "name": "CC API 2",
      "description": "is this one also a great cost center?",
      "company": {
        "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb7",
        "code": "C1",
        "name": "Company 1"
      }
    }
  ],
  "pageable": "INSTANCE",
  "number": 0,
  "size": 10,
  "totalPages": 1,
  "numberOfElements": 3,
  "totalElements": 3,
  "last": true,
  "sort": [
    {
      "direction": "ASC",
      "property": "id"
    }
  ],
  "first": true
}

Create Cost Center

post

Create a cost center.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

codestring · min: 1 · max: 255Required

namestring · min: 1 · max: 255Required

descriptionstring · max: 65535Optional

Responses

201

application/json

400

Bad Request

post

/core/v1/cost-centers

curl -X POST \
  "https://api.catapa.com/core/v1/cost-centers" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id" \
  -H "Content-Type: application/json" \
  -d '{
  "code": "CC",
  "name": "Cost",
  "description": ""
}'

{
  "id": "f1358390-54f8-4cee-9464-6dc0607fe25b",
  "code": "CC",
  "name": "Cost",
  "description": "",
  "company": {
    "id": "12345678-1234-1234-1234-123456789012",
    "code": "COMP-001",
    "name": "Company Name"
  }
}

Update Cost Center

put

Update the cost center.

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

descriptionstring · max: 65535Optional

Responses

200

application/json

idstring · uuidOptional

codestringOptional

namestringOptional

descriptionstringOptional

400

Bad Request

put

/core/v1/cost-centers/{id}

curl -X PUT \
  "https://api.catapa.com/core/v1/cost-centers/f47ac10b-58cc-4372-a567-0e02b2c3d479" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id" \
  -H "Content-Type: application/json" \
  -d '{
  "code": "CC Edit",
  "name": "Cost Edit",
  "description": ""
}'

{
  "id": "f1358390-54f8-4cee-9464-6dc0607fe25b",
  "code": "CC Edit",
  "name": "Cost Edit",
  "description": "",
  "company": {
    "id": "12345678-1234-1234-1234-123456789012",
    "code": "COMP-001",
    "name": "Company Name"
  }
}

Get Job Level

get

Search Query

Supported Keys

Supported Operators

Notes

name

:

Like operator

code

:

Like operator

jobPosistionId

:

Like operator

level

: > <

Equal operator Greater than or equal operator Less than or 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/job-levels

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

{
  "content": [
    {
      "id": "d1cb34e4-d7e8-11e6-bf26-cec0c932ce01",
      "code": "11",
      "name": "Senior Supervisor",
      "effectiveDate": "2024-01-01",
      "endDate": "9999-12-31",
      "jobPosition": {
        "id": "4a166410-d7e8-11e6-bf26-cec0c932ce01",
        "code": "KANIT",
        "name": "KEPALA UNIT"
      },
      "level": 1
    },
    {
      "id": "d1cb312e-d7e8-11e6-bf26-cec0c932ce01",
      "code": "10",
      "name": "Senior Supervisor",
      "effectiveDate": "2024-01-01",
      "endDate": "2024-12-31",
      "jobPosition": {
        "id": "4a166410-d7e8-11e6-bf26-cec0c932ce01",
        "code": "KANIT",
        "name": "KEPALA UNIT"
      },
      "level": 1
    },
    {
      "id": "d1cb2fda-d7e8-11e6-bf26-cec0c932ce01",
      "code": "09",
      "name": "Supervisor",
      "effectiveDate": "2024-01-01",
      "endDate": "9999-12-31",
      "jobPosition": {
        "id": "4a166410-d7e8-11e6-bf26-cec0c932ce01",
        "code": "KANIT",
        "name": "KEPALA UNIT"
      },
      "level": 1
    },
    {
      "id": "d1cb2e7c-d7e8-11e6-bf26-cec0c932ce01",
      "code": "08",
      "name": "Junior Supervisor",
      "effectiveDate": "2024-01-01",
      "endDate": "2024-12-31",
      "jobPosition": {
        "id": "4a166410-d7e8-11e6-bf26-cec0c932ce01",
        "code": "KANIT",
        "name": "KEPALA UNIT"
      },
      "level": 1
    }
  ],
  "pageable": "INSTANCE",
  "number": 0,
  "size": 10,
  "totalPages": 1,
  "numberOfElements": 4,
  "totalElements": 4,
  "last": true,
  "sort": [],
  "first": true,
  "empty": true
}

Create Job Level

post

Create a job level.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

codestring · min: 1 · max: 255Required

levelnumber · min: 1 · max: 99Required

jobPositionIdstringOptional

namestring · min: 1 · max: 255Required

effectiveDatestring · dateRequired

Effective date for the job level. Defaults to minimum date if not provided.

endDatestring · dateOptional

End date for the job level

Responses

201

application/json

400

Bad Request

post

/core/v1/job-levels

curl -X POST \
  "https://api.catapa.com/core/v1/job-levels" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id" \
  -H "Content-Type: application/json" \
  -d '{
  "code": "NEW",
  "level": 1,
  "jobPositionId": "4a166550-d7e8-11e6-bf26-cec0c932ce01",
  "name": "NEW",
  "effectiveDate": "2024-01-01",
  "endDate": "9999-12-31"
}'

{
  "id": "2ee5526d-fe72-4a25-8280-223c785701dc",
  "code": "NEW",
  "name": "NEW",
  "effectiveDate": "2024-01-01",
  "endDate": "9999-12-31",
  "jobPosition": {
    "id": "4a166550-d7e8-11e6-bf26-cec0c932ce01",
    "code": "PELAKSANA",
    "name": "STAFF PELAKSANA"
  },
  "level": 1
}

Get Job Titles

get

minJobLevel and maxJobLevel are deprecated. check Tenant Job Hierarchy Policy setting, it may cause error to this endpoint

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pageintegerOptional

Page number

Default: 0Example: 0

sizeinteger · min: 1 · max: 50Optional

Page size

Default: 10Example: 10

querystringOptional

Search Query

Supported Keys	Supported Operators	Notes
name	`:`	Like operator
code	`:`	Like operator
minJobLevelId	`:`	Equal operator(Deprecated)
maxJobLevelId	`:`	Equal operator(Deprecated)

Example: name:Manager

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/job-titles

curl -X GET \
  "https://api.catapa.com/core/v1/job-titles?page=0&size=10&query=name%3AManager" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "content": [
    {
      "id": "ff6ba12f-adc2-4d9e-910c-9a9a91b062b9",
      "code": "API",
      "name": "API",
      "effectiveDate": "2020-11-11",
      "endDate": "9999-12-31",
      "minJobLevel": {
        "id": "b2c92a5d-a707-44d4-88fa-55bda8450001",
        "code": "021-test",
        "name": "Staff test",
        "effectiveDate": "2020-11-11",
        "endDate": "9999-12-31",
        "jobPosition": {
          "id": "4a166410-d7e8-11e6-bf26-cec0c932ce01",
          "code": "KANIT",
          "name": "KEPALA UNIT"
        },
        "level": 5
      },
      "maxJobLevel": {
        "id": "b2c92a5d-a707-44d4-88fa-55bda8450002",
        "code": "020-test",
        "name": "Senior Staff",
        "effectiveDate": "2020-11-11",
        "endDate": "9999-12-31",
        "jobPosition": {
          "id": "4a166410-d7e8-11e6-bf26-cec0c932ce01",
          "code": "KANIT",
          "name": "KEPALA UNIT"
        },
        "level": 10
      }
    }
  ],
  "totalPages": 1,
  "numberOfElements": 1,
  "totalElements": 1,
  "size": 1,
  "number": 0,
  "last": true,
  "sort": [
    {
      "direction": "ASC",
      "property": "id"
    }
  ],
  "first": true
}

Deprecated

Create Job Title

post

⚠️ This endpoint is deprecated. Please use Create Job Title with Job Levels instead.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

codestring · min: 1 · max: 255Required

namestring · min: 1 · max: 255Required

minJobLevelIdstringOptionalDeprecated

maxJobLevelIdstringOptionalDeprecated

effectiveDatestring · dateOptional

if null, it will be set to 1970-01-01

endDatestring · dateOptional

Responses

201

application/json

400

Bad Request

post

/core/v1/job-titles

curl -X POST \
  "https://api.catapa.com/core/v1/job-titles" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id" \
  -H "Content-Type: application/json" \
  -d '{
  "code": "NEW",
  "name": "NEW",
  "minJobLevelId": "d1cb4b96-d7e8-11e6-bf26-cec0c932ce01",
  "maxJobLevelId": "d1cb4b96-d7e8-11e6-bf26-cec0c932ce0",
  "effectiveDate": "2020-11-11",
  "endDate": "9999-12-31"
}'

{
  "id": "da299f77-d2d3-4177-9e9e-8047218a375b",
  "code": "NEW",
  "name": "NEW",
  "effectiveDate": "2020-11-11",
  "endDate": "9999-12-31",
  "minJobLevel": {
    "id": "d1cb4b96-d7e8-11e6-bf26-cec0c932ce01",
    "code": "Level 1",
    "name": "Level 1",
    "effectiveDate": "2020-11-11",
    "endDate": "9999-12-31",
    "jobPosition": {
      "id": "4a16682a-d7e8-11e6-bf26-cec0c932ce01",
      "code": "BOD/BOC",
      "name": "BOD/BOC"
    },
    "level": 1
  },
  "maxJobLevel": {
    "id": "d1cb4b96-d7e8-11e6-bf26-cec0c932ce01",
    "code": "Level 2",
    "name": "Level 2",
    "effectiveDate": "2020-11-11",
    "endDate": "9999-12-31",
    "jobPosition": {
      "id": "4a16682a-d7e8-11e6-bf26-cec0c932ce01",
      "code": "BOD/BOC",
      "name": "BOD/BOC"
    },
    "level": 1
  }
}

Get Job Title Job Level Mappings

get

minJobLevel and MaxJobLevel are deprecated.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pageintegerOptional

Page number

Default: 0Example: 0

sizeinteger · min: 1 · max: 50Optional

Page size

Default: 10Example: 10

querystringOptional

Search Query

Supported Keys	Supported Operators	Notes
jobLevel.code	`:`	Like operator
jobLevel.name	`:`	Like operator
jobTitle.id	`:`	Equal operator Support multiple values with each value separated by the `;` delimiter
jobLevel.id	`:`	Equal operator Support multiple values with each value separated by the `;` delimiter

Example:

{"summary":"Search Job Title-Job Level Mappings by Multiple Job Title Ids","value":"jobTitle.id:ff6ba12f-adc2-4d9e-910c-9a9a91b062b9;ff6ba12f-adc2-4d9e-910c-9a9a91b06200"}

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/job-title-levels

curl -X GET \
  "https://api.catapa.com/core/v1/job-title-levels?page=0&size=10&query=jobTitle.id%3Aff6ba12f-adc2-4d9e-910c-9a9a91b062b9%3Bff6ba12f-adc2-4d9e-910c-9a9a91b06200" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "content": [
    {
      "jobTitle": {
        "id": "ff6ba12f-adc2-4d9e-910c-9a9a91b062b9",
        "code": "API",
        "name": "API",
        "effectiveDate": "2020-11-11",
        "endDate": "9999-12-31",
        "minJobLevel": {
          "id": "b2c92a5d-a707-44d4-88fa-55bda8450001",
          "code": "021-test",
          "name": "Staff test",
          "effectiveDate": "2020-11-11",
          "endDate": "9999-12-31",
          "jobPosition": {
            "id": "4a166410-d7e8-11e6-bf26-cec0c932ce01",
            "code": "KANIT",
            "name": "KEPALA UNIT"
          },
          "level": 5
        },
        "maxJobLevel": {
          "id": "b2c92a5d-a707-44d4-88fa-55bda8450002",
          "code": "020-test",
          "name": "Senior Staff",
          "effectiveDate": "2020-11-11",
          "endDate": "2020-12-31",
          "jobPosition": {
            "id": "4a166410-d7e8-11e6-bf26-cec0c932ce01",
            "code": "KANIT",
            "name": "KEPALA UNIT"
          },
          "level": 10
        }
      },
      "jobLevel": {
        "id": "d1cb34e4-d7e8-11e6-bf26-cec0c932ce01",
        "code": "11",
        "name": "Senior Supervisor",
        "effectiveDate": "2024-01-01",
        "endDate": "9999-12-31",
        "jobPosition": {
          "id": "4a166410-d7e8-11e6-bf26-cec0c932ce01",
          "code": "KANIT",
          "name": "KEPALA UNIT"
        },
        "level": 1
      }
    }
  ],
  "pageable": "INSTANCE",
  "number": 0,
  "size": 10,
  "totalPages": 1,
  "numberOfElements": 1,
  "totalElements": 1,
  "last": true,
  "sort": [
    {
      "direction": "ASC",
      "property": "id"
    }
  ],
  "first": true
}

Get Location Group

get

Search Query

Supported Keys

Supported Operators

Notes

name

:

Like operator

code

:

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/location-groups

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

{
  "content": [
    {
      "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb7",
      "code": "LG",
      "name": "Location Group"
    }
  ],
  "totalPages": 1,
  "last": true,
  "totalElements": 1,
  "numberOfElements": 1,
  "sort": [
    {
      "direction": "DESC",
      "property": "updatedDate",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    },
    {
      "direction": "DESC",
      "property": "id",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    }
  ],
  "first": true,
  "size": 10,
  "number": 0
}

Get Location

get

Return the locations.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pageintegerOptional

Page number

Default: 0Example: 0

sizeinteger · min: 1 · max: 50Optional

Page size

Default: 10Example: 10

querystringOptional

Search query

Supported Keys	Supported Operators	Notes
name	`:`	Like operator
code	`:`	Like operator
zipCode	`:`	Equal operator
phone	`:`	Equal operator
address	`:`	Equal operator
locationGroupId	`:`	Equal operator
cityId	`:`	Equal operator
endDateIsNull	`:`	Use `true` or `false` to filter locations with null or non-null end date respectively.
effectiveDate	`>` , `<`	Use to filter locations effective after or before the specified date.
endDate	`>` , `<`	Use to filter locations ending after or before the specified date.

Example: {"summary":"Search a location by code","value":"code:JKT"}

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/locations

curl -X GET \
  "https://api.catapa.com/core/v1/locations?page=0&size=10&query=code%3AJKT" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "content": [
    {
      "id": "a31aa166-70be-4303-81e4-5ada93b5213a",
      "code": "JOG",
      "name": "Yogyakarta",
      "locationGroup": {
        "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb7",
        "code": "LG",
        "name": "Location Group"
      },
      "city": {
        "id": "2d1ecc14-a6ea-11e6-80f5-76304dec7eb7",
        "code": "34.71",
        "name": "Kota Yogyakarta",
        "state": {
          "id": "71f5a5fc-a699-11e6-80f5-76304dec7eb7",
          "name": "Special Region Yogyakarta",
          "code": "34",
          "country": {
            "id": "d1eac40e-a691-11e6-80f5-76304dec7eb7",
            "name": "Indonesia",
            "code": "IDN"
          }
        }
      },
      "latitude": -7.7955798,
      "longitude": 110.3694896,
      "address": "Perum Jombor Kavling Indah, Jl. Amerta VIII No. 56, Sinduadi, Mlati, Sleman",
      "phone": "+62274881234",
      "zipCode": "55284",
      "headquarter": false,
      "effectiveDate": "2023-01-01",
      "endDate": "9999-12-31",
      "company": {
        "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb7",
        "code": "COMP-001",
        "name": "PT. CATAPA"
      }
    },
    {
      "id": "f4eaf74f-3e63-414f-b7be-54c46902407f",
      "code": "SBY",
      "name": "Surabaya",
      "locationGroup": {
        "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb8",
        "code": "LG2",
        "name": "Location Group 2"
      },
      "city": {
        "id": "2d1ee1fe-a6ea-11e6-80f5-76304dec7eb7",
        "code": "35.78",
        "name": "Kota Surabaya",
        "state": {
          "id": "71f5a7a0-a699-11e6-80f5-76304dec7eb7",
          "name": "East Java",
          "code": "35",
          "country": {
            "id": "d1eac40e-a691-11e6-80f5-76304dec7eb7",
            "name": "Indonesia",
            "code": "IDN"
          }
        }
      },
      "latitude": -7.2574719,
      "longitude": 112.7520883,
      "address": "Jl. Kedung Doro No.34, Sawahan, Kec. Sawahan",
      "phone": "+62315678901",
      "zipCode": "60251",
      "headquarter": false,
      "effectiveDate": "2023-02-01",
      "endDate": "9999-12-31",
      "company": {
        "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb8",
        "code": "COMP-002",
        "name": "PT. CATAPA II"
      }
    },
    {
      "id": "7b43bb37-fed4-4d76-9838-221ec23647d1",
      "code": "DPS",
      "name": "Denpasar",
      "locationGroup": {
        "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb9",
        "code": "LG3",
        "name": "Location Group 3"
      },
      "city": {
        "id": "2d1ee384-a6ea-11e6-80f5-76304dec7eb7",
        "code": "51.71",
        "name": "Kota Denpasar",
        "state": {
          "id": "71f5a926-a699-11e6-80f5-76304dec7eb7",
          "name": "Bali",
          "code": "51",
          "country": {
            "id": "d1eac40e-a691-11e6-80f5-76304dec7eb7",
            "name": "Indonesia",
            "code": "IDN"
          }
        }
      },
      "latitude": -8.6704582,
      "longitude": 115.2126293,
      "address": "Jl. Tukad Musi IIIB - Panjer",
      "phone": "+62361234567",
      "zipCode": "80361",
      "headquarter": false,
      "effectiveDate": "2023-03-01",
      "endDate": "9999-12-31",
      "company": {
        "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb9",
        "code": "COMP-003",
        "name": "PT. CATAPA III"
      }
    },
    {
      "id": "763a52e7-c386-479a-b330-0d6cb64064de",
      "code": "BDG",
      "name": "Bandung",
      "locationGroup": {
        "id": "61d5f69a-a5a4-1111-80f5-76304dec7ec0",
        "code": "LG4",
        "name": "Location Group 4"
      },
      "city": {
        "id": "2d1eaaf4-a6ea-11e6-80f5-76304dec7eb7",
        "code": "32.73",
        "name": "Kota Bandung",
        "state": {
          "id": "71f5a2d2-a699-11e6-80f5-76304dec7eb7",
          "name": "West Java",
          "code": "32",
          "country": {
            "id": "d1eac40e-a691-11e6-80f5-76304dec7eb7",
            "name": "Indonesia",
            "code": "IDN"
          }
        }
      },
      "latitude": -6.9174639,
      "longitude": 107.6191228,
      "address": "Jl. Dr. Otten No.10",
      "phone": "+62227890123",
      "zipCode": "40132",
      "headquarter": false,
      "effectiveDate": "2023-04-01",
      "endDate": "2024-12-31",
      "company": {
        "id": "61d5f69a-a5a4-1111-80f5-76304dec7ec0",
        "code": "COMP-004",
        "name": "PT. CATAPA IV"
      }
    },
    {
      "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb7",
      "code": "JKT",
      "name": "Jakarta",
      "locationGroup": {
        "id": "61d5f69a-a5a4-1111-80f5-76304dec7ec1",
        "code": "LG5",
        "name": "Location Group 5"
      },
      "city": {
        "id": "2d1e9f5a-a6ea-11e6-80f5-76304dec7eb7",
        "code": "31.73",
        "name": "Kota Adm. Jakarta Barat",
        "state": {
          "id": "71f59dbe-a699-11e6-80f5-76304dec7eb7",
          "name": "Jakarta Special Capital Region",
          "code": "31",
          "country": {
            "id": "d1eac40e-a691-11e6-80f5-76304dec7eb7",
            "name": "Indonesia",
            "code": "IDN"
          }
        }
      },
      "latitude": -6.1753924,
      "longitude": 106.8271528,
      "address": "Menara Citicon, 17th Floor, Jl. Letjen. S. Parman Kav 72",
      "phone": "+62214567890",
      "zipCode": "11410",
      "headquarter": true,
      "effectiveDate": "2023-01-01",
      "endDate": "2024-05-31",
      "company": {
        "id": "61d5f69a-a5a4-1111-80f5-76304dec7ec1",
        "code": "COMP-005",
        "name": "PT. CATAPA V"
      }
    }
  ],
  "totalPages": 1,
  "last": true,
  "totalElements": 5,
  "numberOfElements": 5,
  "sort": [
    {
      "direction": "DESC",
      "property": "updatedDate",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    },
    {
      "direction": "DESC",
      "property": "id",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    }
  ],
  "first": true,
  "size": 10,
  "number": 0
}

Create Location

post

Create a location.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

codestring · min: 1 · max: 255Required

namestring · min: 1 · max: 255Required

latitudenumberOptional

longitudenumberOptional

addressstring · max: 65535Optional

phonestring · max: 255Optional

e.g. +6281234567890

Pattern: ^[+]{1}[0-9-() ]+

zipCodestring · max: 5Optional

Numeric

effectiveDatestring · dateRequired

The date when this location becomes effective

endDatestring · dateOptional

The date when this location is no longer effective. If null, means this location is still effective

headquarterbooleanRequired

If value is true, will automatically update headquarter in company profile

Responses

201

application/json

400

Bad Request

post

/core/v1/locations

curl -X POST \
  "https://api.catapa.com/core/v1/locations" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id" \
  -H "Content-Type: application/json" \
  -d '{
  "code": "CAT88",
  "name": "Catapa HQ",
  "locationGroup": {
    "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb7"
  },
  "city": {
    "id": "2d1ecc14-a6ea-11e6-80f5-76304dec7eb7"
  },
  "latitude": 23.1029437563,
  "longitude": 32.8452647254,
  "address": "Jl. Kedung Doro No.32",
  "phone": "+62476275642743",
  "zipCode": "55284",
  "effectiveDate": "2023-06-01",
  "endDate": "9999-12-31",
  "headquarter": false
}'

{
  "id": "1895eb60-1f5d-44d6-9885-95734a0f9fad",
  "code": "CAT88",
  "name": "Catapa HQ",
  "locationGroup": {
    "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb7",
    "code": "LG",
    "name": "Location Group"
  },
  "city": {
    "id": "2d1ecc14-a6ea-11e6-80f5-76304dec7eb7",
    "code": "34.71",
    "name": "Kota Yogyakarta",
    "state": {
      "id": "71f5a5fc-a699-11e6-80f5-76304dec7eb7",
      "name": "Special Region Yogyakarta",
      "code": "34",
      "country": {
        "id": "d1eac40e-a691-11e6-80f5-76304dec7eb7",
        "name": "Indonesia",
        "code": "IDN"
      }
    }
  },
  "latitude": 23.1029437563,
  "longitude": 32.8452647254,
  "address": "Jl. Kedung Doro No.32",
  "phone": "+62476275642743",
  "zipCode": "55284",
  "headquarter": false,
  "effectiveDate": "2023-06-01",
  "endDate": "9999-12-31"
}

Get Sub Location

get

Return the sub locations.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pageintegerOptional

Page number

Default: 0Example: 0

sizeinteger · min: 1 · max: 50Optional

Page size

Default: 10Example: 10

querystringOptional

Search Query

Supported Keys	Supported Operators	Notes
id	`:`	Equal operator Support multiple values with each value separated by the `;` delimiter
name	`:`	Like operator
code	`:`	Like operator
location.id	`:`	Equal operator
endDateIsNull	`:`	Use `true` or `false` to filter sub-locations with null or non-null end date respectively.
effectiveDate	`>` , `<`	Use to filter sub-locations effective after or before the specified date.
endDate	`>` , `<`	Use to filter sub-locations ending after or before the specified date.

Example: {"summary":"Search a sub-location by ID","value":"id:a31aa166-70be-4303-81e4-5ada93b5213a"}

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/sub-locations

curl -X GET \
  "https://api.catapa.com/core/v1/sub-locations?page=0&size=10&query=id%3Aa31aa166-70be-4303-81e4-5ada93b5213a" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "content": [
    {
      "id": "a31aa166-70be-4303-81e4-5ada93b5213a",
      "code": "FL-1",
      "name": "First Floor",
      "location": {
        "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb7",
        "code": "JKT",
        "name": "Jakarta",
        "company": {
          "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb7",
          "code": "COMP-001",
          "name": "PT. CATAPA"
        },
        "effectiveDate": "2023-01-01",
        "endDate": "9999-12-31"
      },
      "effectiveDate": "2023-01-01",
      "endDate": "2023-12-31"
    },
    {
      "id": "f4eaf74f-3e63-414f-b7be-54c46902407f",
      "code": "FL-2",
      "name": "Second Floor",
      "location": {
        "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb7",
        "code": "JKT",
        "name": "Jakarta",
        "company": {
          "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb8",
          "code": "COMP-002",
          "name": "PT. CATAPA II"
        },
        "effectiveDate": "2023-01-01",
        "endDate": "9999-12-31"
      },
      "effectiveDate": "2023-01-01",
      "endDate": "9999-12-31"
    },
    {
      "id": "7b43bb37-fed4-4d76-9838-221ec23647d1",
      "code": "FL-3",
      "name": "Third Floor",
      "location": {
        "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb7",
        "code": "JKT",
        "name": "Jakarta",
        "company": {
          "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb9",
          "code": "COMP-003",
          "name": "PT. CATAPA III"
        },
        "effectiveDate": "2023-01-01",
        "endDate": "2023-12-31"
      },
      "effectiveDate": "2023-01-01",
      "endDate": "2023-12-31"
    }
  ],
  "totalPages": 1,
  "last": true,
  "totalElements": 3,
  "numberOfElements": 3,
  "sort": [
    {
      "direction": "DESC",
      "property": "updatedDate",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    }
  ],
  "first": true,
  "size": 10,
  "number": 0
}

Add Sub Location

post

Add a sub location.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

codestring · min: 1 · max: 255Required

namestring · min: 1 · max: 255Required

locationIdstringRequired

Parent location ID

effectiveDatestring · dateRequired

The date when the sub-location becomes effective

endDatestring · dateOptional

The date when the sub-location ends; null means no planned end date / active indefinitely

Responses

201

Created

application/json

400

Bad Request

post

/core/v1/sub-locations

curl -X POST \
  "https://api.catapa.com/core/v1/sub-locations" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id" \
  -H "Content-Type: application/json" \
  -d '...'

{
  "id": "a31aa166-70be-4303-81e4-5ada93b5213a",
  "code": "FL-1",
  "name": "First Floor",
  "location": {
    "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb7",
    "code": "JKT",
    "name": "Jakarta",
    "locationGroup": {
      "id": "61d5f69a-a5a4-1111-80f5-76304dec7ec1",
      "code": "LG5",
      "name": "Location Group 5"
    },
    "city": {
      "id": "2d1e9f5a-a6ea-11e6-80f5-76304dec7eb7",
      "code": "31.73",
      "name": "Kota Adm. Jakarta Barat",
      "state": {
        "id": "71f59dbe-a699-11e6-80f5-76304dec7eb7",
        "name": "Jakarta Special Capital Region",
        "code": "31",
        "country": {
          "id": "d1eac40e-a691-11e6-80f5-76304dec7eb7",
          "code": "IDN",
          "callingCode": "+62",
          "name": "Indonesia",
          "taxTreaty": false
        }
      }
    },
    "effectiveDate": "2023-01-01",
    "endDate": "9999-12-31"
  },
  "effectiveDate": "2023-01-01",
  "endDate": "2023-12-31"
}

Delete Sub Location

delete

This endpoint expects a JSON array in the request body, where each item is an object containing an id field representing the sub-location to delete. The array must contain at least 1 item. Request body schema: json [ { "id": "string" } ] Example payload: json [ { "id": "a31aa166-70be-4303-81e4-5ada93b5213a" } ]

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Bodyobject[]

idstringRequired

Unique identifier

Responses

200

application/json

400

Bad Request

delete

/core/v1/sub-locations

curl -X DELETE \
  "https://api.catapa.com/core/v1/sub-locations" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id" \
  -H "Content-Type: application/json" \
  -d '[
  {
    "id": "a31aa166-70be-4303-81e4-5ada93b5213a"
  }
]'

{
  "successes": [
    {
      "id": "a31aa166-70be-4303-81e4-5ada93b5213a"
    }
  ],
  "failures": []
}

Get Operational Groups

get

Return the operational groups.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pageintegerOptional

Page number

Default: 0Example: 0

sizeinteger · min: 1 · max: 50Optional

Page size

Default: 10Example: 10

querystringOptional

Search Query

Supported Keys	Supported Operators	Notes
id	`:`	Equal operator Support multiple values with each value separated by the `;` delimiter
name	`:`	Like operator
code	`:`	Like operator

Example: {"summary":"Search an operational group by ID","value":"id:a31aa166-70be-4303-81e4-5ada93b5213a"}

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/operational-groups

curl -X GET \
  "https://api.catapa.com/core/v1/operational-groups?page=0&size=10&query=id%3Aa31aa166-70be-4303-81e4-5ada93b5213a" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "content": [
    {
      "id": "a31aa166-70be-4303-81e4-5ada93b5213a",
      "code": "OG-1",
      "name": "Production Team"
    },
    {
      "id": "f4eaf74f-3e63-414f-b7be-54c46902407f",
      "code": "OG-2",
      "name": "Quality Assurance"
    },
    {
      "id": "7b43bb37-fed4-4d76-9838-221ec23647d1",
      "code": "OG-3",
      "name": "Research and Development"
    }
  ],
  "totalPages": 1,
  "last": true,
  "totalElements": 3,
  "numberOfElements": 3,
  "sort": [
    {
      "direction": "DESC",
      "property": "updatedDate",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    }
  ],
  "first": true,
  "size": 10,
  "number": 0
}

Get Organization Group

get

Search Query

Supported Keys

Supported Operators

Notes

name

:

Like operator

code

:

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/organization-groups

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

{
  "content": [
    {
      "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb7",
      "code": "OG",
      "name": "Organization Group"
    }
  ],
  "totalPages": 1,
  "last": true,
  "totalElements": 1,
  "numberOfElements": 1,
  "sort": [
    {
      "direction": "DESC",
      "property": "updatedDate",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    },
    {
      "direction": "DESC",
      "property": "id",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    }
  ],
  "first": true,
  "size": 10,
  "number": 0
}

Create Organization Group

post

Create an organization group.

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/organization-groups

curl -X POST \
  "https://api.catapa.com/core/v1/organization-groups" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id" \
  -H "Content-Type: application/json" \
  -d '{
  "code": "GRP123",
  "name": "Engineering Department"
}'

{
  "id": "ab1a286b-4c8b-4d28-8b5b-7a2e10cc3cf1",
  "code": "GRP123",
  "name": "Engineering Department"
}

Get Organization Hierarchies

get

Search Query

Supported Keys

Supported Operators

Notes

name

:

Like operator

code

:

Like operator

color

:

Like operator

level

: < >

Equal operator Less than or equal operator Greater than or 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/organization-hierarchies

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

{
  "content": [
    {
      "id": "a896cc20-aba9-11e6-80f5-76304dec7eb7",
      "code": "004",
      "name": "Unit",
      "color": "#62A4D5",
      "level": 4
    },
    {
      "id": "a896cf54-aba9-11e6-80f5-76304dec7eb7",
      "code": "003",
      "name": "Divisi",
      "color": "#E8CF44",
      "level": 3
    },
    {
      "id": "a896d062-aba9-11e6-80f5-76304dec7eb7",
      "code": "002",
      "name": "Departemen",
      "color": "#B7783A",
      "level": 2
    },
    {
      "id": "a896d3be-aba9-11e6-80f5-76304dec7eb7",
      "code": "001",
      "name": "Direktorat",
      "color": "#379353",
      "level": 1
    }
  ],
  "totalPages": 1,
  "last": true,
  "totalElements": 4,
  "numberOfElements": 4,
  "sort": [
    {
      "direction": "DESC",
      "property": "updatedDate",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    },
    {
      "direction": "DESC",
      "property": "id",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    }
  ],
  "first": true,
  "size": 10,
  "number": 0
}

Create Organization Hierarchies

post

Create the organization hierarchies.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

codestring · min: 1 · max: 255Required

namestring · min: 1 · max: 255Required

colorstring · min: 7 · max: 7Optional

Hexadecimal color code, e.g. #62A4D5

levelnumber · min: 1 · max: 99Required

Responses

201

application/json

400

Bad Request

post

/core/v1/organization-hierarchies

curl -X POST \
  "https://api.catapa.com/core/v1/organization-hierarchies" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id" \
  -H "Content-Type: application/json" \
  -d '{
  "code": "004",
  "name": "Unit",
  "color": "#62A4D5",
  "level": 4
}'

{
  "id": "a896cc20-aba9-11e6-80f5-76304dec7eb7",
  "code": "004",
  "name": "Unit",
  "color": "#62A4D5",
  "level": 4
}

Get Organization

get

Deprecated: The organizationParent field in the response is deprecated and will always return null. Please use the Organization Superior API instead.

Search Query

Supported Keys

Supported Operators

Notes

:

Equal operator Support multiple values with each value separated by the ; delimiter

name

:

Like operator

code

:

Like operator

type

:

Equal operator

organizationGroupId

:

Equal operator

organizationHierarchyId

:

Equal operator

organizationParentId

:

Equal operator. Deprecated: Use Organization Superior API instead.

haveParent

:

Equal operator. Deprecated: Use Organization Superior API instead.

organizationChildrenId

:

Equal operator

level

: < >

Equal operator Less than or equal operator Greater than or equal operator

company.id

:

Equal operator

effectiveDate

< >

Less than or equal operator Greater than or equal operator

endDate

< >

Less than or equal operator Greater than or equal operator

endDateIsNull

:

Equal operator

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pageintegerOptional

Page number

Default: 0Example: 0

sizeinteger · min: 1 · max: 50Optional

Page size

Default: 10Example: 10

querystringOptional

Search query string

Example: name:Engineering

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/organizations

curl -X GET \
  "https://api.catapa.com/core/v1/organizations?page=0&size=10&query=name%3AEngineering" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "content": [
    {
      "id": "8adeb122-acab-11e6-80f5-76304dec7eb7",
      "code": "001",
      "name": "BOD",
      "type": "FUNCTIONAL",
      "effectiveDate": "1970-01-01",
      "endDate": "2099-12-31",
      "createdBy": "system",
      "createdDate": 1478586884810,
      "updatedBy": "system",
      "updatedDate": 1478586884810,
      "organizationHierarchy": {
        "id": "a896d3be-aba9-11e6-80f5-76304dec7eb7",
        "code": "001",
        "name": "Direktorat",
        "color": "#379353",
        "level": 1
      },
      "organizationGroup": {
        "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb7",
        "code": "OG",
        "name": "Organization Group"
      },
      "organizationParent": {},
      "company": {
        "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb7",
        "code": "COMP-001",
        "name": "CATAPA"
      }
    },
    {
      "id": "8adebaf0-acab-11e6-80f5-76304dec7eb7",
      "code": "003",
      "name": "HRD",
      "type": "FUNCTIONAL",
      "organizationHierarchy": {
        "id": "a896d062-aba9-11e6-80f5-76304dec7eb7",
        "code": "002",
        "name": "Departemen",
        "color": "#B7783A",
        "level": 2
      },
      "organizationGroup": {
        "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb7",
        "code": "OG",
        "name": "Organization Group"
      },
      "organizationParent": {},
      "company": {
        "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb7",
        "code": "COMP-001",
        "name": "CATAPA"
      }
    },
    {
      "id": "8adeb8b6-acab-11e6-80f5-76304dec7eb7",
      "code": "002",
      "name": "ICT",
      "type": "FUNCTIONAL",
      "effectiveDate": "1970-01-01",
      "endDate": "2099-12-31",
      "createdBy": "system",
      "createdDate": 1478586884810,
      "updatedBy": "system",
      "updatedDate": 1478586884810,
      "organizationHierarchy": {
        "id": "a896d062-aba9-11e6-80f5-76304dec7eb7",
        "code": "002",
        "name": "Departemen",
        "color": "#B7783A",
        "level": 2
      },
      "organizationGroup": {
        "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb7",
        "code": "OG",
        "name": "Organization Group"
      },
      "organizationParent": {},
      "company": {
        "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb7",
        "code": "COMP-001",
        "name": "CATAPA"
      }
    }
  ],
  "totalPages": 1,
  "last": true,
  "totalElements": 3,
  "numberOfElements": 3,
  "sort": [
    {
      "direction": "DESC",
      "property": "updatedDate",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    },
    {
      "direction": "DESC",
      "property": "id",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    }
  ],
  "first": true,
  "size": 10,
  "number": 0
}

Create Organization

post

Create an organization.

Deprecated: The organizationParentId request field and organizationParent response field are deprecated. Please use the Organization Superior API instead.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

codestring · min: 1 · max: 255Required

organizationHierarchyIdstringRequired

organizationParentIdstringOptionalDeprecated

Deprecated. Organization Parent is deprecated. Please use the Organization Superior API instead.

namestring · min: 3 · max: 255Required

typestring · enumRequiredPossible values:

organizationGroupIdstringOptional

companyIdstringOptional

If the request is null, then it will default to the earliest company created in the system.

Responses

201

application/json

400

Bad Request

post

/core/v1/organizations

curl -X POST \
  "https://api.catapa.com/core/v1/organizations" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id" \
  -H "Content-Type: application/json" \
  -d '{
  "code": "BBCA",
  "organizationHierarchyId": "a896d3be-aba9-11e6-80f5-76304dec7eb7",
  "organizationParentId": "8adeb122-acab-11e6-80f5-76304dec7eb7",
  "name": "PT Bank Central Asia Tbk.",
  "type": "FUNCTIONAL",
  "organizationGroupId": "61d5f69a-a5a4-1111-80f5-76304dec7eb7",
  "companyId": "61d5f69a-a5a4-1111-80f5-76304dec7eb7"
}'

{
  "id": "9e20fea5-0c11-4370-9748-afcdbdd8e3f0",
  "code": "BBCA",
  "name": "PT Bank Central Asia Tbk.",
  "type": "FUNCTIONAL",
  "effectiveDate": "1970-01-01",
  "endDate": "2099-12-31",
  "createdBy": "system",
  "createdDate": 1478586884810,
  "updatedBy": "system",
  "updatedDate": 1478586884810,
  "organizationHierarchy": {
    "id": "a896d3be-aba9-11e6-80f5-76304dec7eb7",
    "code": "001",
    "name": "Direktorat",
    "color": "#379353",
    "level": 1
  },
  "organizationGroup": {
    "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb7",
    "code": "DJRM",
    "name": "Djarum"
  },
  "organizationParent": {},
  "company": {
    "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb7",
    "code": "COMP-001",
    "name": "CATAPA"
  }
}

Get Organization Heads

get

Return the organization heads.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pageintegerOptional

Page number

Default: 0Example: 0

sizeinteger · min: 1 · max: 50Optional

Page size

Default: 10Example: 10

querystringOptional

Search Query

Supported Keys	Supported Operators	Notes
id	`:`	Equal operator Support multiple values with each value separated by the `;` delimiter
organization.company.id	`:`	Equal operator
organization.id	`:`	Equal operator Support multiple values with each value separated by the `;` delimiter

Example:

{"summary":"Search organization heads by IDs","value":"id:a31aa166-70be-4303-81e4-5ada93b5213a;0332e2b1-ba56-4a33-9d8a-6e66a4acde21"}

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/organizations/heads

curl -X GET \
  "https://api.catapa.com/core/v1/organizations/heads?page=0&size=10&query=id%3Aa31aa166-70be-4303-81e4-5ada93b5213a%3B0332e2b1-ba56-4a33-9d8a-6e66a4acde21" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "content": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "effectiveDate": "2023-06-01",
      "organization": {
        "id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
        "code": "DEPT-001",
        "name": "Engineering Department"
      },
      "position": {
        "id": "6ba7b811-9dad-11d1-80b4-00c04fd430c9",
        "code": "MGR-ENG",
        "name": "Engineering Manager"
      }
    },
    {
      "id": "b3efe784-2e05-4afc-aae9-1425e55490bf",
      "effectiveDate": "2023-03-01",
      "organization": {
        "id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
        "code": "DEPT-001",
        "name": "Engineering Department"
      },
      "position": {
        "id": "6ba7b811-9dad-11d1-80b4-00c04fd430c9",
        "code": "MGR-ENG",
        "name": "Engineering Manager"
      }
    }
  ],
  "totalPages": 1,
  "last": true,
  "totalElements": 1,
  "numberOfElements": 2,
  "sort": [
    {
      "direction": "DESC",
      "property": "effectiveDate",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    }
  ],
  "first": true,
  "size": 10,
  "number": 0
}

Get Organization Histories

get

Return the organization histories.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pageintegerOptional

Page number

Default: 0Example: 0

sizeinteger · min: 1 · max: 50Optional

Page size

Default: 10Example: 10

querystringOptional

Search Query

Supported Keys	Supported Operators	Notes
id	`:`	Equal operator Support multiple values with each value separated by the `;` delimiter
organization.id	`:`	Equal operator Support multiple values with each value separated by the `;` delimiter
type	`:`	Equal operator Support multiple values with each value separated by the `;` delimiter
organization.company.id	`:`	Equal operator Support multiple values with each value separated by the `;` delimiter
organizationGroup.id	`:`	Equal operator Support multiple values with each value separated by the `;` delimiter
effectiveDate	`>`, `<`	Greater than or equal / Less than or equal operators Date format: YYYY-MM-DD
endDate	`>`, `<`	Greater than or equal / Less than or equal operators Date format: YYYY-MM-DD

Example:

{"summary":"Search organization histories by IDs","value":"id:a31aa166-70be-4303-81e4-5ada93b5213a;0332e2b1-ba56-4a33-9d8a-6e66a4acde21"}

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/organizations/histories

curl -X GET \
  "https://api.catapa.com/core/v1/organizations/histories?page=0&size=10&query=id%3Aa31aa166-70be-4303-81e4-5ada93b5213a%3B0332e2b1-ba56-4a33-9d8a-6e66a4acde21" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "content": [
    {
      "id": "org-001",
      "code": "001",
      "name": "001",
      "organization": {
        "id": "org-123",
        "code": "ACME",
        "name": "Acme Corporation"
      },
      "company": {
        "id": "comp-001",
        "code": "COMP",
        "name": "COMP Corporation"
      },
      "type": "STRUCTURAL",
      "organizationHierarchy": {
        "id": "hie-001",
        "code": "HR001",
        "name": "HROUP",
        "level": 1
      },
      "organizationGroup": {
        "id": "group-001",
        "code": "GR001",
        "name": "GROUP"
      },
      "effectiveDate": "2022-01-15",
      "endDate": "2023-12-31"
    },
    {
      "id": "org-002",
      "code": "001",
      "name": "001",
      "organization": {
        "id": "org-123",
        "code": "ACME",
        "name": "Acme Corporation"
      },
      "company": {
        "id": "comp-001",
        "code": "COMP",
        "name": "COMP Corporation"
      },
      "type": "STRUCTURAL",
      "organizationHierarchy": {
        "id": "hie-001",
        "code": "HR001",
        "name": "HROUP",
        "level": 1
      },
      "organizationGroup": {
        "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb7",
        "code": "OG",
        "name": "Organization Group"
      },
      "effectiveDate": "2024-01-01",
      "endDate": "2099-12-31"
    }
  ],
  "totalPages": 1,
  "last": true,
  "totalElements": 2,
  "numberOfElements": 2,
  "sort": [
    {
      "direction": "DESC",
      "property": "effectiveDate",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    }
  ],
  "first": true,
  "size": 20,
  "number": 0
}

Get Organization Superiors

get

Return the organization superiors.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pageintegerOptional

Page number

Default: 0Example: 0

sizeinteger · min: 1 · max: 50Optional

Page size

Default: 10Example: 10

querystringOptional

Search Query

Supported Keys	Supported Operators	Notes
id	`:`	Equal operator Support multiple values with each value separated by the `;` delimiter
organization.id	`:`	Equal operator Support multiple values with each value separated by the `;` delimiter
superior.id	`:`	Equal operator Support multiple values with each value separated by the `;` delimiter
effectiveDate	`gte`, `lte`	Greater than or equal / Less than or equal operators Date format: YYYY-MM-DD

Example: {"summary":"Search organization superiors by IDs","value":"id:org-001;org-002"}

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/organizations/superiors

curl -X GET \
  "https://api.catapa.com/core/v1/organizations/superiors?page=0&size=10&query=id%3Aorg-001%3Borg-002" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "content": [
    {
      "id": "org-001",
      "organization": {
        "id": "org-123",
        "code": "ACME",
        "name": "Acme Corporation"
      },
      "superior": {
        "id": "group-001",
        "code": "GR001",
        "name": "GROUP"
      },
      "effectiveDate": "2022-01-15"
    },
    {
      "id": "org-002",
      "organization": {
        "id": "org-123",
        "code": "ACME",
        "name": "Acme Corporation"
      },
      "superior": {
        "id": "group-001",
        "code": "GR001",
        "name": "GROUP"
      },
      "effectiveDate": "2024-01-01"
    },
    {
      "id": "org-003",
      "organization": {
        "id": "org-456",
        "code": "BETA",
        "name": "Beta Corporation"
      },
      "superior": {
        "id": "group-002",
        "code": "GR002",
        "name": "GROUP 2"
      },
      "effectiveDate": "2024-06-01"
    }
  ],
  "totalPages": 1,
  "last": true,
  "totalElements": 3,
  "numberOfElements": 3,
  "sort": [
    {
      "direction": "DESC",
      "property": "effectiveDate",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    }
  ],
  "first": true,
  "size": 20,
  "number": 0
}

Get Positions

get

Return the positions.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pageintegerOptional

Page number

Default: 0Example: 0

sizeinteger · min: 1 · max: 50Optional

Page size

Default: 10Example: 10

querystringOptional

Get a list of positions with pagination support.

Search Query

Supported Keys	Supported Operators	Notes
id	`:`	Equal operator Support multiple values with each value separated by the `;` delimiter
name	`:`	Like operator
code	`:`	Like operator

Example: name:Engineer

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/positions

curl -X GET \
  "https://api.catapa.com/core/v1/positions?page=0&size=10&query=name%3AEngineer" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "content": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "code": "POS001",
      "name": "Software Engineer",
      "createdBy": "system",
      "createdDate": 1727370164151,
      "updatedBy": "system",
      "updatedDate": 1727370164151
    },
    {
      "id": "123e4567-e89b-12d3-a456-426614174001",
      "code": "POS002",
      "name": "Product Manager",
      "createdBy": "system",
      "createdDate": 1727370164151,
      "updatedBy": "system",
      "updatedDate": 1727370164151
    }
  ],
  "totalPages": 1,
  "last": true,
  "totalElements": 2,
  "numberOfElements": 2,
  "first": true,
  "size": 10,
  "number": 0
}

Get Position Cost Centers

get

Return the position cost centers.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pageintegerOptional

Page number

Default: 0Example: 0

sizeinteger · min: 1 · max: 50Optional

Page size

Default: 10Example: 10

querystringOptional

Search Query

Supported Keys	Supported Operators	Notes
id	`:`	Equal operator Support multiple values with each value separated by the `;` delimiter
position.id	`:`	Equal operator Support multiple values with each value separated by the `;` delimiter

Example:

{"summary":"Search cost centers by IDs","value":"id:a31aa166-70be-4303-81e4-5ada93b5213a;0332e2b1-ba56-4a33-9d8a-6e66a4acde21"}

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/positions/cost-centers

curl -X GET \
  "https://api.catapa.com/core/v1/positions/cost-centers?page=0&size=10&query=id%3Aa31aa166-70be-4303-81e4-5ada93b5213a%3B0332e2b1-ba56-4a33-9d8a-6e66a4acde21" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "content": [
    {
      "id": "a31aa166-70be-4303-81e4-5ada93b5213a",
      "effectiveDate": "2023-10-31",
      "costCenter": {
        "id": "a46e387f-7a16-4794-b8b9-1087cd5fa80f",
        "code": "C-01",
        "name": "Cost Center 01"
      },
      "position": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "code": "P-01",
        "name": "Position 01"
      },
      "createdBy": "system",
      "createdDate": 1478586884810,
      "updatedBy": "system",
      "updatedDate": 1478586884810
    },
    {
      "id": "f4eaf74f-3e63-414f-b7be-54c46902407f",
      "effectiveDate": "2024-11-30",
      "costCenter": {
        "id": "463cac73-f830-474a-92c2-1847e1c5af37",
        "code": "C-02",
        "name": "Cost Center 02"
      },
      "position": {
        "id": "123e4567-e89b-12d3-a456-426614174001",
        "code": "P-02",
        "name": "Position 02"
      },
      "createdBy": "system",
      "createdDate": 1478586884810,
      "updatedBy": "system",
      "updatedDate": 1478586884810
    }
  ],
  "totalPages": 1,
  "last": true,
  "totalElements": 2,
  "numberOfElements": 2,
  "sort": [
    {
      "direction": "DESC",
      "property": "effectiveDate",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    }
  ],
  "first": true,
  "size": 10,
  "number": 0
}

Get Position Histories

get

Return the position histories.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pageintegerOptional

Page number

Default: 0Example: 0

sizeinteger · min: 1 · max: 50Optional

Page size

Default: 10Example: 10

querystringOptional

Search Query

Supported Keys	Supported Operators	Notes
id	`:`	Equal operator Support multiple values with each value separated by the `;` delimiter
position.id	`:`	Equal operator Support multiple values with each value separated by the `;` delimiter
organization.id	`:`	Equal operator Support multiple values with each value separated by the `;` delimiter

Example:

{"summary":"Search position histories by IDs","value":"id:a31aa166-70be-4303-81e4-5ada93b5213a;0332e2b1-ba56-4a33-9d8a-6e66a4acde21"}

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/positions/histories

curl -X GET \
  "https://api.catapa.com/core/v1/positions/histories?page=0&size=10&query=id%3Aa31aa166-70be-4303-81e4-5ada93b5213a%3B0332e2b1-ba56-4a33-9d8a-6e66a4acde21" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "content": [
    {
      "id": "a31aa166-70be-4303-81e4-5ada93b5213a",
      "code": "PH-01",
      "name": "POSITION HISTORY 01",
      "position": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "code": "P-01",
        "name": "Position 01"
      },
      "organization": {
        "id": "123e4567-e89b-12d3-a456-426614174999",
        "code": "O-01",
        "name": "Organization 01",
        "company": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "code": "COMP-01",
          "name": "COMPANY 01"
        }
      },
      "effectiveDate": "2024-01-01",
      "endDate": "2025-12-31"
    },
    {
      "id": "f4eaf74f-3e63-414f-b7be-54c46902407f",
      "code": "PH-02",
      "name": "POSITION HISTORY 02",
      "position": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "code": "P-01",
        "name": "Position 01"
      },
      "organization": {
        "id": "123e4567-e89b-12d3-a456-426614174999",
        "code": "O-01",
        "name": "Organization 01",
        "company": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "code": "COMP-01",
          "name": "COMPANY 01"
        }
      },
      "effectiveDate": "2024-01-01",
      "endDate": "2025-12-31"
    }
  ],
  "totalPages": 1,
  "last": true,
  "totalElements": 2,
  "numberOfElements": 2,
  "sort": [
    {
      "direction": "DESC",
      "property": "effectiveDate",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    }
  ],
  "first": true,
  "size": 10,
  "number": 0
}

Get Position Vacancy Statuses

get

Return the position vacancy statuses.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pageintegerOptional

Page number

Default: 0Example: 0

sizeinteger · min: 1 · max: 50Optional

Page size

Default: 10Example: 10

querystringOptional

Search Query

Supported Keys	Supported Operators	Notes
id	`:`	Equal operator Support multiple values with each value separated by the `;` delimiter
position.id	`:`	Equal operator Support multiple values with each value separated by the `;` delimiter
vacancyStatus	`:`	Equal operator Support multiple values with each value separated by the `;` delimiter

Example:

{"summary":"Search vacancy statuses by IDs","value":"id:a31aa166-70be-4303-81e4-5ada93b5213a;0332e2b1-ba56-4a33-9d8a-6e66a4acde21"}

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/positions/vacancy-statuses

curl -X GET \
  "https://api.catapa.com/core/v1/positions/vacancy-statuses?page=0&size=10&query=id%3Aa31aa166-70be-4303-81e4-5ada93b5213a%3B0332e2b1-ba56-4a33-9d8a-6e66a4acde21" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "content": [
    {
      "id": "a31aa166-70be-4303-81e4-5ada93b5213a",
      "effectiveDate": "2023-10-31",
      "vacancyStatus": "FILLED",
      "position": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "code": "P-01",
        "name": "Position 01"
      },
      "createdBy": "system",
      "createdDate": 1478586884810,
      "updatedBy": "system",
      "updatedDate": 1478586884810
    },
    {
      "id": "f4eaf74f-3e63-414f-b7be-54c46902407f",
      "effectiveDate": "2024-11-30",
      "vacancyStatus": "VACANT",
      "position": {
        "id": "123e4567-e89b-12d3-a456-426614174001",
        "code": "P-02",
        "name": "Position 02"
      },
      "createdBy": "system",
      "createdDate": 1478586884810,
      "updatedBy": "system",
      "updatedDate": 1478586884810
    }
  ],
  "totalPages": 1,
  "last": true,
  "totalElements": 2,
  "numberOfElements": 2,
  "sort": [
    {
      "direction": "DESC",
      "property": "effectiveDate",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "ascending": false,
      "descending": true
    }
  ],
  "first": true,
  "size": 10,
  "number": 0
}

Last updated 16 days ago

hashtagGet Company

hashtagCreate Company

hashtagGet Company Groups

Search Query

hashtagGet Cost Center

hashtagCreate Cost Center

hashtagUpdate Cost Center

hashtagGet Job Level

hashtagSearch Query

hashtagCreate Job Level

hashtagGet Job Titles

Search Query

hashtagCreate Job Title

hashtagGet Job Title Job Level Mappings

Search Query

hashtagGet Location Group

hashtagSearch Query

hashtagGet Location

Search query

hashtagCreate Location

hashtagGet Sub Location

Search Query

hashtagAdd Sub Location

hashtagDelete Sub Location

hashtagGet Operational Groups

Search Query

hashtagGet Organization Group

hashtagSearch Query

hashtagCreate Organization Group

hashtagGet Organization Hierarchies

hashtagSearch Query

hashtagCreate Organization Hierarchies

hashtagGet Organization

hashtagSearch Query

hashtagCreate Organization

hashtagGet Organization Heads

Search Query

hashtagGet Organization Histories

Search Query

hashtagGet Organization Superiors

Search Query

hashtagGet Positions

Search Query

hashtagGet Position Cost Centers

Search Query

hashtagGet Position Histories

Search Query

hashtagGet Position Vacancy Statuses

Search Query

Get Company

Create Company

Get Company Groups

Get Cost Center

Create Cost Center

Update Cost Center

Get Job Level

Search Query

Create Job Level

Get Job Titles

Create Job Title

Get Job Title Job Level Mappings

Get Location Group

Search Query

Get Location

Create Location

Get Sub Location

Add Sub Location

Delete Sub Location

Get Operational Groups

Get Organization Group

Search Query

Create Organization Group

Get Organization Hierarchies

Search Query

Create Organization Hierarchies

Get Organization

Search Query

Create Organization

Get Organization Heads

Get Organization Histories

Get Organization Superiors

Get Positions

Get Position Cost Centers

Get Position Histories

Get Position Vacancy Statuses