Token payroll

Get Token Payroll Contributors

Lists contributors of a token payroll.

GEThttps://api.toku.com/stablecoin-payroll/get-token-payroll-contributors

Not available to API keys.

curl --request GET \
  --url 'https://api.toku.com/stablecoin-payroll/get-token-payroll-contributors?tokenPayrollID=%3CtokenPayrollID%3E' \
  --header 'Authorization: Bearer <token>'
200 response
{
  "contributors": [
    {
      "contributorInTokenPayrollID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tokenPayrollID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "roleInOrgID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "invoicePaymentID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "totalPayrollAmount": "string",
      "totalDeductionAmount": "string",
      "netPayrollAmount": "string",
      "currency": "string",
      "tokenTypeID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "roleInOrg": {
        "hrAutomationOnly": true,
        "legacyMigratedAt": "2026-01-01T00:00:00Z",
        "legacyModelID": 0,
        "roleInOrgID": "string",
        "personID": "string",
        "orgID": "string",
        "invitedByInvestorID": "string",
        "invitedByRecipientID": "string",
        "roleInOrgExternalID": 0,
        "externalEmployeeID": "string",
        "positionID": "string",
        "jobTitle": "string",
        "country": "string",
        "countryCode": "ABW",
        "preferredInvoiceCurrency": "string",
        "status": "string",
        "lifecycleStatus": "INVITED",
        "workEmail": "string",
        "department": "string",
        "legalEntity": "string",
        "payrollEntity": "string",
        "contractEntityID": "string",
        "onboarded": true,
        "isTerminated": true,
        "privilegedAdmin": true,
        "isPrimaryAdmin": true,
        "isOrgMarketMaker": true,
        "role": "TOKU_ADMIN",
        "employmentType": "CONTRACTOR",
        "revokedAt": "2026-01-01T00:00:00Z",
        "createdAt": "2026-01-01T00:00:00Z",
        "updatedAt": "2026-01-01T00:00:00Z",
        "payrollEmployeeID": "string",
        "hasWelcomeEmailSent": true,
        "subEmploymentType": "string",
        "remarks": "string",
        "isITAdmin": true,
        "isExternalEmployee": true,
        "employeeSyncedSource": "CSV_UPLOAD",
        "investorFullName": "string",
        "baseSalary": "string",
        "baseSalaryCurrency": "TRY",
        "baseSalaryPaymentType": "FIAT",
        "baseSalaryTokenTypeID": "string",
        "baseSalaryTokenSymbol": "string",
        "baseSalaryTokenNetwork": "string",
        "baseSalaryPeriod": "HOURLY",
        "stablecoinPayPercentage": 0,
        "maxStablecoinPercentage": 0,
        "taxMethod": "NO_TAX",
        "withholdingPercentage": "string",
        "lastLogin": "2026-01-01T00:00:00Z",
        "lastTestTxReminderBy": "string",
        "lastTestTxReminderAt": "2026-01-01T00:00:00Z",
        "payrollFileNumber": "string",
        "externalPayrollId": "string",
        "lastOnboardingReminderBy": "string",
        "lastOnboardingReminderAt": "2026-01-01T00:00:00Z",
        "address": "string",
        "payrollGroup": "string",
        "lastInactiveWalletReminderBy": "string",
        "lastInactiveWalletReminderAt": "2026-01-01T00:00:00Z",
        "recipientType": "PERSON",
        "receiveNotificationEmails": true,
        "receiveInAppNotifications": true,
        "notificationEmailFrequency": "OFF",
        "receiveSlackNotifications": true,
        "selfServeContractorOnboardingStatus": "NOT_STARTED",
        "selfServeContractorOnboardingCompletedAt": "2026-01-01T00:00:00Z",
        "selfServeWelcomeEmailSentAt": "2026-01-01T00:00:00Z",
        "numberOfPayPeriodsPerYear": 0,
        "managerRoleInOrgID": "string",
        "managerPath": [
          "string"
        ],
        "person": {
          "personID": "string",
          "givenName": "string",
          "familyName": "string",
          "middleName": "string",
          "createdAt": "2026-01-01T00:00:00Z",
          "updatedAt": "2026-01-01T00:00:00Z",
          "legacyMigratedAt": "2026-01-01T00:00:00Z",
          "legacyModelID": 0,
          "mergedIntoPersonID": "string",
          "mergedAt": "2026-01-01T00:00:00Z",
          "fullName": "string",
          "users": [
            {
              "userID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "loginEmail": "string",
              "isPrimaryLogin": true,
              "createdAt": "2026-01-01T00:00:00Z"
            }
          ]
        },
        "invoiceApproverRoutingUpdatedAt": "2026-01-01T00:00:00Z",
        "isServiceSeat": true
      },
      "tokenPayroll": {
        "tokenPayrollID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "paymentBackend": "LEGACY",
        "paymentOwnershipVersion": 0,
        "orgID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "string",
        "payPeriodStart": "2026-01-01T00:00:00Z",
        "payPeriodEnd": "2026-01-01T00:00:00Z",
        "payDate": "2026-01-01T00:00:00Z",
        "externalPayrollID": "string",
        "fiatCurrency": "TRY",
        "payrollEntityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "state": "DRAFT",
        "type": "ON_CYCLE",
        "payrollGroup": "string",
        "integrationEntityName": "string",
        "payrollIntegrationEntityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "isFiatPayrollComplete": true,
        "isTokenPayrollComplete": true,
        "fundingEmailSent": true,
        "adpDeductionsVerified": true,
        "payrollSyncedSource": "CSV_UPLOAD",
        "isPlaceholder": true,
        "selectedTokenTypeID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "isStablecoinOnlySettlement": true,
        "createdAt": "2026-01-01T00:00:00Z",
        "updatedAt": "2026-01-01T00:00:00Z"
      }
    }
  ]
}

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is an access token from a Toku sign-in. See Authentication in the API reference.

Query parameters

tokenPayrollIDstringrequired

Allowed: 1 to 200 characters

Response

200Successful response
contributorsobject[]required
Show child attributes
contributorInTokenPayrollIDstring<uuid>required
tokenPayrollIDstring<uuid>required
roleInOrgIDstring<uuid>required
invoicePaymentIDstring | null<uuid>required
totalPayrollAmountstring<decimal>required

Allowed: matches ^-?[0-9]+(\.[0-9]+)?$

totalDeductionAmountstring<decimal>required

Allowed: matches ^-?[0-9]+(\.[0-9]+)?$

netPayrollAmountstring<decimal>required

Allowed: matches ^-?[0-9]+(\.[0-9]+)?$

currencystring | nullrequired
tokenTypeIDstring | null<uuid>required
roleInOrgobjectrequired
Show child attributes
hrAutomationOnlybooleanrequired
legacyMigratedAtstring | null<date-time>required
legacyModelIDinteger | nullrequired
roleInOrgIDstringrequired
personIDstringrequired
orgIDstringrequired
invitedByInvestorIDstring | nullrequired
invitedByRecipientIDstring | nullrequired
roleInOrgExternalIDintegerrequired
externalEmployeeIDstring | nullrequired
positionIDstring | nullrequired
jobTitlestring | nullrequired
countrystring | nullrequired
countryCodestring | nullrequired

Available options: ABW, AFG, AGO, AIA, ALA, ALB, AND, ARE, ARG, ARM, ASM, ATA, ATF, ATG, AUS, AUT, AZE, BDI, BEL, BEN, BES, BFA, BGD, BGR, BHR, BHS, BIH, BLR, BLZ, BMU, BOL, BRA, BRB, BRN, BTN, BVT, BWA, CAF, CAN, CCK, CHE, CHL, CHN, CIV, CMR, COD, COG, COK, COL, COM, CPV, CRI, CUB, CUW, CXR, CYM, CYP, CZE, DEU, DJI, DMA, DNK, DOM, DZA, ECU, EGY, ERI, ESH, ESP, EST, ETH, FIN, FJI, FLK, FRA, FRO, FSM, GAB, GBR, GEO, GGY, GHA, GIB, GIN, GLP, GMB, GNB, GNQ, GRC, GRD, GRL, GTM, GUF, GUM, GUY, HKG, HMD, HND, HRV, HTI, HUN, IDN, IMN, IND, IOT, IRL, IRN, IRQ, ISL, ISR, ITA, JAM, JEY, JOR, JPN, KAZ, KEN, KGZ, KHM, KIR, KNA, KOR, KWT, LAO, LBN, LBR, LBY, LCA, LIE, LKA, LSO, LTU, LUX, LVA, MAC, MAF, MAR, MCO, MDA, MDG, MDV, MEX, MHL, MKD, MLI, MLT, MMR, MNE, MNG, MNP, MOZ, MRT, MSR, MTQ, MUS, MWI, MYS, MYT, NAM, NCL, NER, NFK, NGA, NIC, NIU, NLD, NOR, NPL, NRU, NZL, OMN, PAK, PAN, PCN, PER, PHL, PLW, PNG, POL, PRI, PRK, PRT, PRY, PSE, PYF, QAT, REU, ROU, RUS, RWA, SAU, SDN, SEN, SGP, SGS, SHN, SJM, SLB, SLE, SLV, SMR, SOM, SPM, SRB, SSD, STP, SUR, SVK, SVN, SWE, SWZ, SXM, SYC, SYR, TCA, TCD, TGO, THA, TJK, TKL, TKM, TLS, TON, TTO, TUN, TUR, TUV, TWN, TZA, UGA, UKR, UMI, URY, USA, UZB, VAT, VCT, VEN, VGB, VIR, VNM, VUT, WLF, WSM, YEM, ZAF, ZMB, ZWE, null

preferredInvoiceCurrencystring | nullrequired
statusstring | nullrequired
lifecycleStatusstring | nullrequired

Available options: INVITED, ONBOARDING, ACTIVE, OFFBOARDING, TERMINATED, ARCHIVED, null

workEmailstring | nullrequired
departmentstring | nullrequired
legalEntitystring | nullrequired
payrollEntitystring | nullrequired
contractEntityIDstring | nullrequired
onboardedbooleanrequired
isTerminatedbooleanrequired
privilegedAdminbooleanrequired
isPrimaryAdminbooleanrequired
isOrgMarketMakerbooleanrequired
rolestringrequired

Available options: TOKU_ADMIN, CLIENT_ORG_ADMIN, CLIENT_ORG_APPROVER, FINANCE_ADMIN, USER, INVESTOR, SUB_INVESTOR, SUB_RECIPIENT

employmentTypestring | nullrequired

Available options: CONTRACTOR, EMPLOYEE, EX_EMPLOYEE, ADVISOR, SERVICE_PROVIDER, OTHER, null

revokedAtstring | null<date-time>required
createdAtstring<date-time>required
updatedAtstring<date-time>required
payrollEmployeeIDstring | nullrequired
hasWelcomeEmailSentbooleanrequired
subEmploymentTypestring | nullrequired
remarksstring | nullrequired
isITAdminbooleanrequired
isExternalEmployeebooleanrequired
employeeSyncedSourcestring | nullrequired

Available options: CSV_UPLOAD, WORKDAY, ADP, UKG, TOKUEOR, TRINET, GUSTO, DEEL, BAMBOOHR, IMPORTED, OTHER, null

investorFullNamestring | nullrequired
baseSalarystring | null<decimal>required

Allowed: matches ^-?[0-9]+(\.[0-9]+)?$

baseSalaryCurrencystring | nullrequired

Available options: TRY, ILS, CRC, TTD, SGD, JPY, AUD, NOK, INR, GBP, CHF, RUB, CAD, BRL, NGN, KRW, AED, LBP, EUR, NZD, ZAR, USD, USDC, USDT, USDP, PHP, PLN, RSD, HKD, TWD, AFN, AMD, ANG, AOA, ARS, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BSD, BTN, BWP, BYN, BZD, CDF, CLF, CLP, CNY, COP, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, FJD, FKP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HNL, HRK, HTG, HUF, IDR, IQD, IRR, ISK, JMD, JOD, KES, KGS, KHR, KMF, KPW, KWD, KYD, KZT, LAK, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NPR, NIO, OMR, PAB, PEN, PGK, PKR, PYG, QAR, RON, RWF, SAR, SBD, SCR, SDG, SHP, SLL, SOS, SRD, SSP, STN, SVC, SYP, SZL, TJS, TMT, TND, TOP, TZS, UAH, UGX, UYU, UZS, VES, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZMW, SEK, THB, null

baseSalaryPaymentTypestringrequired

Available options: FIAT, TOKEN

baseSalaryTokenTypeIDstring | nullrequired
baseSalaryTokenSymbolstring | nullrequired
baseSalaryTokenNetworkstring | nullrequired
baseSalaryPeriodstring | nullrequired

Available options: HOURLY, MONTHLY, YEARLY, null

stablecoinPayPercentagenumber | nullrequired
maxStablecoinPercentagenumber | nullrequired
taxMethodstring | nullrequired

Available options: NO_TAX, MANUAL_TAX, TAX_ENGINE, BULK_UPLOAD, null

withholdingPercentagestring | null<decimal>required

Allowed: matches ^-?[0-9]+(\.[0-9]+)?$

lastLoginstring | null<date-time>required
lastTestTxReminderBystring | nullrequired
lastTestTxReminderAtstring | null<date-time>required
payrollFileNumberstring | nullrequired
externalPayrollIdstring | nullrequired
lastOnboardingReminderBystring | nullrequired
lastOnboardingReminderAtstring | null<date-time>required
addressstring | nullrequired
payrollGroupstring | nullrequired
lastInactiveWalletReminderBystring | nullrequired
lastInactiveWalletReminderAtstring | null<date-time>required
recipientTypestring | nullrequired

Available options: PERSON, ENTITY, null

receiveNotificationEmailsbooleanrequired
receiveInAppNotificationsbooleanrequired
notificationEmailFrequencystringrequired

Available options: OFF, IMMEDIATE, DAILY

receiveSlackNotificationsbooleanrequired
selfServeContractorOnboardingStatusstringrequired

Available options: NOT_STARTED, IN_PROGRESS, COMPLETED

selfServeContractorOnboardingCompletedAtstring | null<date-time>required
selfServeWelcomeEmailSentAtstring | null<date-time>required
numberOfPayPeriodsPerYearintegerrequired
managerRoleInOrgIDstring | nullrequired
managerPathstring[]required
personobjectrequired
Show child attributes
personIDstringrequired
givenNamestringrequired
familyNamestringrequired
middleNamestring | nullrequired
createdAtstring<date-time>required
updatedAtstring<date-time>required
legacyMigratedAtstring | null<date-time>required
legacyModelIDinteger | nullrequired
mergedIntoPersonIDstring | nullrequired
mergedAtstring | null<date-time>required
fullNamestringrequired
usersobject[]required
Show child attributes
userIDstring<uuid>required
loginEmailstringrequired
isPrimaryLoginbooleanrequired
createdAtstring<date-time>required
invoiceApproverRoutingUpdatedAtstring | null<date-time>required
isServiceSeatbooleanrequired
tokenPayrollobjectrequired
Show child attributes
tokenPayrollIDstring<uuid>required
paymentBackendstring | nullrequired

Available options: LEGACY, UNIFIED, null

paymentOwnershipVersionintegerrequired
orgIDstring<uuid>required
namestring | nullrequired
payPeriodStartstring<date-time>required
payPeriodEndstring<date-time>required
payDatestring<date-time>required
externalPayrollIDstring | nullrequired
fiatCurrencystringrequired

Available options: TRY, ILS, CRC, TTD, SGD, JPY, AUD, NOK, INR, GBP, CHF, RUB, CAD, BRL, NGN, KRW, AED, LBP, EUR, NZD, ZAR, USD, USDC, USDT, USDP, PHP, PLN, RSD, HKD, TWD, AFN, AMD, ANG, AOA, ARS, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BSD, BTN, BWP, BYN, BZD, CDF, CLF, CLP, CNY, COP, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, FJD, FKP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HNL, HRK, HTG, HUF, IDR, IQD, IRR, ISK, JMD, JOD, KES, KGS, KHR, KMF, KPW, KWD, KYD, KZT, LAK, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NPR, NIO, OMR, PAB, PEN, PGK, PKR, PYG, QAR, RON, RWF, SAR, SBD, SCR, SDG, SHP, SLL, SOS, SRD, SSP, STN, SVC, SYP, SZL, TJS, TMT, TND, TOP, TZS, UAH, UGX, UYU, UZS, VES, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZMW, SEK, THB

payrollEntityIdstring | null<uuid>required
statestringrequired

Available options: DRAFT, PENDING, OVERDUE, LOCKED, IN_PROGRESS, APPROVED, COMPLETED, CANCELLED

typestringrequired

Available options: ON_CYCLE, OFF_CYCLE, INVOICE_PAYMENT

payrollGroupstring | nullrequired
integrationEntityNamestring | nullrequired
payrollIntegrationEntityIdstring | null<uuid>required
isFiatPayrollCompletebooleanrequired
isTokenPayrollCompletebooleanrequired
fundingEmailSentbooleanrequired
adpDeductionsVerifiedbooleanrequired
importedDataanyrequired
payrollSyncedSourcestring | nullrequired
isPlaceholderbooleanrequired
selectedTokenTypeIDstring | null<uuid>required
isStablecoinOnlySettlementbooleanrequired
createdAtstring<date-time>required
updatedAtstring<date-time>required
400Bad request
401Unauthorized
403Forbidden
404Not found
409Conflict
429Response 429
Was this page helpful? Suggest edits