Nxsys API Documentation
  1. Candidates
Nxsys API Documentation
  • Introduction
    • Nxsys API Documentation
    • Base URL and Environments
    • Handling Errors
    • Pagination
    • Best Practices
  • Authentication
    • Overview
    • Step 1: Create a Client Application
    • Step 2: Obtain Authorization Code
    • Step 3: Exchange your Authorization Code for an Access Token
    • Step 4: Refresh your Access Token
  • APIs
    • Authentication
      • Construct the Authorization URL
      • Exchange your Authorization Code for an Access Token
    • Candidates
      • Create Candidate
        POST
      • Get Candidates
        GET
      • Update Candidate
        PUT
    • VAT Codes
      • Get Default VAT Codes
    • PaymentRate
      • Create Payment Rate
      • Get Payment Rates
      • Get Single Payment Rate
      • Update Payment Rate
    • Timesheet
      • Create Timesheet
      • Get Timesheets
      • Get Single Timesheet
      • Update Timesheet
    • Payslips
      • Get Payslips
  1. Candidates

Get Candidates

Nxsys Umbrella - Production
https://api.nxsys.tech
Nxsys Umbrella - Production
https://api.nxsys.tech
GET
https://api.nxsys.tech
/nxsys/candidates
Retrieve a paginated list of candidates with optional filters and sorting.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.nxsys.tech/nxsys/candidates?page&size' \
--header 'Authorization;'
Response Response Example
200 - Example 1
{
    "items": [
        {
            "id": "SR-101002",
            "incrementId": 100558,
            "systemId": "ST-101002",
            "forename": "StatutorySMP",
            "surname": "Monthly",
            "fullName": "StatutorySMP Monthly",
            "NINumber": "SG458548A",
            "mobile": null,
            "email": "asdf22@yopmail.com",
            "agencyRef": "SG458548A",
            "status": "ACTIVE",
            "registrationStatus": "PENDING",
            "payFrequency": "MONTHLY",
            "isIssuedP45": null,
            "isOnHold": false,
            "createdAt": "2025-07-07T12:15:48.693Z",
            "department": null,
            "companyPayment": {
                "id": "COM-48",
                "companyName": "ACME contracting ",
                "splitSalaryAndBonus": true
            },
            "primaryAgency": null,
            "setting": {
                "paymentModel": "PAYEE",
                "cisStatus": null,
                "personalVerificationNumber": null,
                "verificationDate": null,
                "matchDate": null,
                "UTRNo": null,
                "marginMethod": null,
                "margin": null,
                "marginCapped": null,
                "holidayPayOpeningBalance": null,
                "holidayPaySumOfAccrued": null,
                "holidayPaySumOfPaid": null,
                "ppsNumber": null,
                "loanTypes": [],
                "taxCode": "1257L",
                "expenseClaimRule": "DISALLOW",
                "holidayPayBalance": 0,
                "haveOutstandingHolidayPay": false,
                "taxBasis": "W1M1"
            },
            "paymentModel": "PAYEE",
            "erPensionPercentage": null,
            "eePensionPercentage": null,
            "eePensionPercentageRAS": null,
            "erPensionFixedAmount": null,
            "eePensionFixedAmount": null
        },
        {
            "id": "SR-99865",
            "incrementId": 99421,
            "systemId": "ST-99865",
            "forename": "DRC",
            "surname": "DRC",
            "fullName": "DRC DRC",
            "NINumber": null,
            "mobile": null,
            "email": "123@gmail.com",
            "agencyRef": "ST-99865",
            "status": "ACTIVE",
            "registrationStatus": "PENDING",
            "payFrequency": "WEEKLY",
            "isIssuedP45": null,
            "isOnHold": false,
            "createdAt": "2025-06-11T03:31:06.511Z",
            "department": null,
            "companyPayment": {
                "id": "COM-48",
                "companyName": "ACME contracting ",
                "splitSalaryAndBonus": true
            },
            "primaryAgency": null,
            "setting": {
                "paymentModel": "CIS",
                "cisStatus": "VERIFIED_20%",
                "personalVerificationNumber": "1231231",
                "verificationDate": "2025-06-08T00:00:00.000Z",
                "matchDate": "2025-06-08T00:00:00.000Z",
                "UTRNo": "1231",
                "marginMethod": null,
                "margin": null,
                "marginCapped": null,
                "holidayPayOpeningBalance": 0,
                "holidayPaySumOfAccrued": 0,
                "holidayPaySumOfPaid": 0,
                "ppsNumber": null,
                "loanTypes": [],
                "taxCode": "1257L",
                "expenseClaimRule": "DISALLOW",
                "holidayPayBalance": 0,
                "haveOutstandingHolidayPay": false,
                "taxBasis": "W1M1"
            },
            "paymentModel": "CIS",
            "errorSubmittingSmartPension": null,
            "errorUpdatingSmartPension": null,
            "errorsSubmittingNestPension": null,
            "erPensionPercentage": null,
            "eePensionPercentage": null,
            "eePensionPercentageRAS": null,
            "erPensionFixedAmount": null,
            "eePensionFixedAmount": null
        }
    ],
    "meta": {
        "totalItems": 372,
        "itemCount": 2,
        "itemsPerPage": 2,
        "totalPages": 186,
        "currentPage": 1
    },
    "success": true
}

Request

Authorization
Add parameter in header
Authorization
Example:
Authorization: ********************
Query Params

Responses

🟢200OK
application/json
Request successful
Body

🟠400Bad Request
🟠401Unauthorized
🔴500Server Error
Previous
Create Candidate
Next
Update Candidate
Built with