User

These endpoints let you manage users in the system. It allows you to retrieve user information, roles, and permissions.

Get Users

get

Return the users.

Authorizations

BearerAuth

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
usernameIn	:	Equal operator Support multiple values with each value separated by the ; delimiter
emailIn	:	Equal operator Support multiple values with each value separated by the ; delimiter

Example: {"summary":"Search user by username","value":"usernameIn:pros;senior;gamer"}

Responses

200

Successful operation

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

cURLPython SDK

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

{
  "content": [
    {
      "id": "ccc1c86e-eba5-414a-98f6-58e6db7d61a9",
      "username": "david",
      "email": "[e-mail]",
      "employee": {
        "id": "eb5269ef-3e7b-4d79-8d30-a04a64b9bfc1",
        "identificationNumber": "ABC-FTUY",
        "name": "name",
        "joinDate": "2019-01-01",
        "startDate": "2025-07-01",
        "active": true,
        "pointOfHire": {
          "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb7",
          "code": "SDT",
          "name": "Sopo Del Tower",
          "locationGroup": {
            "id": "81d5f69a-a5a4-1111-80f5-76304dec7eb7",
            "code": "LG-001",
            "name": "Location Group Name"
          },
          "city": {
            "id": "2d1ea6bc-a6ea-11e6-80f5-76304dec7eb7",
            "code": "31.74",
            "name": "Kota Adm. Jakarta Selatan",
            "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
              }
            }
          },
          "latitude": -6.23086,
          "longitude": 106.82403,
          "address": "Sopo Del Office Tower and Lifestyle, Jl. Mega Kuningan Barat III No.RT.5, RT.3/RW.2, Kuningan, Karet Kuningan, Setia Budi, Kota Jakarta Selatan, Daerah Khusus Ibukota Jakarta 12950, Indonesia",
          "phone": "[phone]",
          "zipCode": "11410",
          "headquarter": false,
          "company": {
            "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb7",
            "code": "COMP-001",
            "name": "PT. CATAPA"
          }
        },
        "photo": {
          "url": "https://example.com/photo.jpg"
        },
        "manager": {
          "id": "0100902f-5d8f-4de4-8fae-5ced86831dd1",
          "identificationNumber": "MGR-001",
          "name": "Jane Smith",
          "joinDate": "2020-01-01",
          "startDate": "2020-01-01",
          "active": true
        }
      }
    },
    {
      "id": "06b474c6-48ea-4e9f-a627-3b530c68e3cf",
      "username": "test123999",
      "email": "[e-mail]",
      "employee": {
        "id": "cc5c2323-70e1-4e06-b267-66727f7edf88",
        "identificationNumber": "Test BPJS Wage 5",
        "name": "Test BPJS Wage 5",
        "joinDate": "2025-01-01",
        "startDate": "2025-01-01",
        "active": true,
        "pointOfHire": {
          "id": "0f2e5cda-78c3-4157-b20a-03b213d6b4dd",
          "code": "099",
          "name": "0993",
          "locationGroup": {
            "id": "81d5f69a-a5a4-1111-80f5-76304dec7eb7",
            "code": "LG-001",
            "name": "Location Group Name"
          },
          "city": {
            "id": "9d320fbb-2a80-41ad-82c6-057f49115753",
            "code": "31.70",
            "name": "Jakarta",
            "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
              }
            }
          },
          "latitude": -6.21109,
          "longitude": 106.84217,
          "address": "4, Jl. Menteng Wadas Timur No.5g, RW.7, Kuningan, Ps. Manggis, Kecamatan Setiabudi, Kota Jakarta Selatan, Daerah Khusus Ibukota Jakarta 12970, Indonesia",
          "phone": "",
          "zipCode": "12333",
          "headquarter": true,
          "company": {
            "id": "61d5f69a-a5a4-1111-80f5-76304dec7eb7",
            "code": "COMP-001",
            "name": "PT. CATAPA"
          }
        },
        "photo": {
          "url": "https://example.com/photo.jpg"
        },
        "manager": {
          "id": "0100902f-5d8f-4de4-8fae-5ced86831dd1",
          "identificationNumber": "MGR-001",
          "name": "Jane Smith",
          "joinDate": "2020-01-01",
          "startDate": "2020-01-01",
          "active": true
        }
      }
    }
  ],
  "totalPages": 462,
  "last": false,
  "totalElements": 4615,
  "numberOfElements": 10,
  "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 Current User

get

Return the current user.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

idstringOptional

usernamestringOptional

emailstringOptional

400

Bad Request

get

/v1/users/me

cURLPython SDK

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

{
  "id": "b8c68ee3-1b65-45e5-ab23-d90fd6795d9a",
  "username": "username",
  "email": "[e-mail]",
  "employee": {
    "id": "9365df57-b0ac-461c-9ae2-24f561807682",
    "name": "Employee Name"
  },
  "roles": [
    {
      "id": "ad940279-539e-44fb-ab07-474e76a7a04f",
      "name": "Role Name",
      "active": true
    }
  ]
}