---
title: "List Incomes"
method: GET
path: "/incomes"
tags: ["Incomes"]
---

# List Incomes

`GET /incomes`

List the user's incomes from employment data sources.

## Query parameters

- `size` integer
- `cursor` string
- `userId` string
- `accountId` string
- `startDate` string, date
- `endDate` string, date
- `sourceId` string

## Response `200`

OK

- IncomeListResponse
  - `code` 'OK' | 'CREATED' | 'INVALID_CREDENTIALS' | 'INVALID_PARAMETERS' | 'INVALID_TOKEN' | 'UNAUTHORIZED_ACCESS' | 'MISSING_RESOURCE' | 'REQUEST_LIMIT_EXCEEDED' | 'SERVER_ERROR' | 'UNSUPPORTED_METHOD' | 'SERVER_UNAVAILABLE' | 'TIME_LIMIT_EXCEEDED' — Request status code
  - `message` string — Message response to the request
  - `requestId` string — Unique ID that is added to the body of every response for easy traceability of the request in our logs.
  - `data` IncomeListData
    - `nextCursor` string — The next cursor value that can be used in the following query.
    - `items` Income[]
      - `id` string, required — Unique ID of this object
      - `workItem` string, nullable — Work performed (specially in the case of contract or freelance jobs)
      - `employer` string, nullable — Employer name
      - `startDate` string, date, required — Start date
      - `endDate` string, date, nullable — End date
      - `currency` 'AFN' | 'DZD' | 'ARS' | 'AMD' | 'AWG' | 'AUD' | 'AZN' | 'BSD' | 'BHD' | 'THB' | 'PAB' | 'BBD' | 'BYN' | 'BZD' | 'BMD' | 'VES' | 'BOB' | 'BRL' | 'BND' | 'BGN' | 'BIF' | 'CAD' | 'CVE' | 'KYD' | 'GHS' | 'XOF' | 'XAF' | 'XPF' | 'CLP' | 'COP' | 'KMF' | 'CDF' | 'BAM' | 'NIO' | 'CRC' | 'HRK' | 'CZK' | 'GMD' | 'DKK' | 'MKD' | 'DJF' | 'STD' | 'DOP' | 'VND' | 'XCD' | 'EGP' | 'SVC' | 'ETB' | 'EUR' | 'FKP' | 'FJD' | 'HUF' | 'GIP' | 'HTG' | 'PYG' | 'GNF' | 'GYD' | 'HKD' | 'UAH' | 'ISK' | 'INR' | 'IRR' | 'IQD' | 'JMD' | 'JOD' | 'KES' | 'PGK' | 'LAK' | 'EEK' | 'KWD' | 'MWK' | 'AOA' | 'MMK' | 'GEL' | 'LVL' | 'LBP' | 'ALL' | 'HNL' | 'SLL' | 'LRD' | 'LYD' | 'SZL' | 'LTL' | 'LSL' | 'MGA' | 'MYR' | 'TMT' | 'MUR' | 'MZN' | 'MXN' | 'MDL' | 'MAD' | 'NGN' | 'ERN' | 'NAD' | 'NPR' | 'ANG' | 'ILS' | 'RON' | 'TWD' | 'NZD' | 'BTN' | 'KPW' | 'NOK' | 'PEN' | 'MRO' | 'TOP' | 'PKR' | 'MOP' | 'UYU' | 'PHP' | 'GBP' | 'BWP' | 'QAR' | 'GTQ' | 'ZAR' | 'OMR' | 'KHR' | 'MVR' | 'IDR' | 'RUB' | 'RWF' | 'SHP' | 'SAR' | 'RSD' | 'SCR' | 'SGD' | 'SBD' | 'KGS' | 'SOS' | 'TJS' | 'LKR' | 'SDG' | 'SRD' | 'SEK' | 'CHF' | 'SYP' | 'BDT' | 'WST' | 'TZS' | 'KZT' | 'TTD' | 'MNT' | 'TND' | 'TRY' | 'AED' | 'UGX' | 'CLF' | 'USD' | 'UZS' | 'VUV' | 'KRW' | 'YER' | 'JPY' | 'CNY' | 'ZMW' | 'ZWL' | 'PLN', required — Currency in 3 character alpha ISO 4217
      - `frequency` 'Hourly' | 'Daily' | 'Weekly' | 'Semimonthly' | 'Monthly' | 'Bimonthly' | 'Quarterly' | 'Annually' | 'Variable' | 'Unspecified' | 'null', nullable — Pay period
      - `baseAmount` number, nullable — Base amount
      - `grossAmount` number, nullable — Gross amount
      - `netAmount` number, nullable — Net amount
      - `metadata` ObjectReferenceMetadata, required — Metadata related to account-specific data
        - `itemCreatedAt` string, date-time, required — Date and time
        - `createdAt` string, date-time, required — Date and time
        - `accountId` string — The accountId of this object
        - `sourceId` string, required — The ACCOUNT or ARCHIVE ID associated with this object
        - `sourceType` 'ACCOUNT' | 'UPLOAD' | 'ARCHIVE' | 'SOCIAL_SECURITY', nullable, required — Source Type
        - `userId` string, required — The user ID associated with this object
        - `providerId` string, required — The provider ID associated with this object

---

[API](https://skmtc.dev/smileapi/apis/smile-api.md) · [All operations](https://skmtc.dev/smileapi/apis/smile-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/smileapi/smile-api/revisions/a4930eb49f4d/schema)