> ## Documentation Index
> Fetch the complete documentation index at: https://developer.findity.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List users

> Returns a paginated list of the users of the given organization. A user is a person employed by the organization; `id` and `externalSourceId` belong to that employment, so the same person is a different user in every organization they belong to. Deleted users are not listed.

The response contains personal data (`ssn`, `bankAccountNumber`, `IBAN`, `BIC`) and is only returned to administrators of the organization.

Returns 404 when the organization does not exist or the authenticated user is not an administrator of it, so a caller cannot tell an organization they lack access to from a missing one.




## OpenAPI

````yaml /openapi/findity-admin-api.json get /organizations/{organizationId}/users
openapi: 3.1.0
info:
  title: Findity Admin API
  description: Findity Admin API
  version: 1.0.0
servers:
  - url: https://stage-api.findity.com/api/v1/admin
  - url: https://api.findity.com/api/v1/admin
security:
  - bearerAuth: []
paths:
  /organizations/{organizationId}/users:
    get:
      tags:
        - Users
      summary: List users
      description: >
        Returns a paginated list of the users of the given organization. A user
        is a person employed by the organization; `id` and `externalSourceId`
        belong to that employment, so the same person is a different user in
        every organization they belong to. Deleted users are not listed.


        The response contains personal data (`ssn`, `bankAccountNumber`, `IBAN`,
        `BIC`) and is only returned to administrators of the organization.


        Returns 404 when the organization does not exist or the authenticated
        user is not an administrator of it, so a caller cannot tell an
        organization they lack access to from a missing one.
      operationId: adminListOrganizationUsers
      parameters:
        - name: organizationId
          in: path
          required: true
          description: >
            Required. String. Identifies the organization whose users are
            listed. Accepts either the organization's internal ID (32-character
            hexadecimal string) or its `externalSourceId` (the string an
            integration set on the organization). This endpoint supports
            externalId: when the value has the format of an internal ID and an
            organization with that ID exists, the internal ID takes precedence;
            otherwise the value is looked up as `externalSourceId`.
          schema:
            type: string
          example: 11adfe2a080040e3892ffb89c21ec44e
        - name: sort
          in: query
          required: false
          style: form
          explode: false
          description: >
            Optional. String. Sort order of the users, as one or more
            `field:direction` criteria applied in the given order. Send several
            criteria either as one comma-separated list
            (`sort=lastName:asc,firstName:asc`) or as repeated parameters
            (`sort=lastName:asc&sort=firstName:asc`). This definition describes
            the comma-separated form, which is what generated clients and the
            "try it" console send; repeated parameters are accepted as well.
            Supported fields: `firstName`, `lastName`, `email`, `employeeId`,
            `title`, `endDate`, `lastInvitationDate`, `dateCreated`. Supported
            directions: `asc`, `desc`; `asc` applies when the direction is left
            out. Criteria with an unsupported field are ignored. Defaults to
            `firstName:asc,lastName:asc` when omitted or when no criterion is
            supported. Users with equal values for every criterion are always
            returned in the same order, so pages never overlap.
          schema:
            type: array
            items:
              type: string
              pattern: >-
                ^(firstName|lastName|email|employeeId|title|endDate|lastInvitationDate|dateCreated)(:(asc|desc))?$
            default:
              - firstName:asc
              - lastName:asc
          example:
            - lastName:asc
            - firstName:asc
        - name: max
          in: query
          required: false
          description: >
            Optional. Integer. Maximum number of users to return in one page.
            Must be between 1 and 1000. Defaults to 10.
          schema:
            type: integer
            minimum: 1
            maximum: 1000
            default: 10
          example: 50
        - name: offset
          in: query
          required: false
          description: >
            Optional. Integer. Zero-based index of the first user to return,
            used together with `max` to page through the list. Must be 0 or
            greater. Defaults to 0.
          schema:
            type: integer
            minimum: 0
            default: 0
          example: 0
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ArrayOfAdminApiUsers'
              example:
                meta:
                  total: 2
                  count: 2
                data:
                  - id: 8a66aa549e6a3672019e73b79f8e1a7f
                    externalSourceId: Erik_Exempel
                    employeeId: null
                    title: Engineering Lead
                    firstName: Erik
                    lastName: Exempel
                    email: erik.exempel@example.com
                    mobilePhone: '+46701740605'
                    endDate: null
                    ssn: '1212121212'
                    department:
                      id: 9360d03ad7294220868d67f42a2a144d
                      externalSourceId: null
                    customDimensionPresetValues: []
                    language: en_GB
                    bankAccountNumber: null
                    IBAN: null
                    BIC: null
                    lastInvitationDate: '2026-06-08T14:32:50Z'
                    dateCreated: '2026-05-29T12:31:14Z'
                    isAdministrator: true
                  - id: 4fcf7515629d49518d480990d8951c88
                    externalSourceId: HR-10442
                    employeeId: '10442'
                    title: Account Manager
                    firstName: Maja
                    lastName: Lind
                    email: maja.lind@example.com
                    mobilePhone: null
                    endDate: '2026-12-31T00:00:00Z'
                    ssn: null
                    department:
                      id: 63b7a7802a644e8ca296c9796ffa7074
                      externalSourceId: SAP-4711
                    customDimensionPresetValues:
                      - id: a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4
                        dimensionDefinitionId: PROJECT
                        presetListValueId: c0ffee00c0ffee00c0ffee00c0ffee00
                        presetListValueText: Project Apollo
                        presetStringValue: null
                    language: sv_SE
                    bankAccountNumber: '832791234567890'
                    IBAN: SE4550000000058398257466
                    BIC: ESSESESS
                    lastInvitationDate: null
                    dateCreated: '2025-11-03T08:15:00Z'
                    isAdministrator: false
        '400':
          description: Bad request — invalid `max` or `offset` value
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/400Error'
              examples:
                Invalid max value:
                  value:
                    result: error
                    code: GENERIC
                    description: 'max must be between an integer between 1 and 1000 was: 0'
                Invalid offset value:
                  value:
                    result: error
                    code: GENERIC
                    description: 'offset must be an integer >= 0 was: -1'
        '404':
          description: >-
            Not found — the organization does not exist or the authenticated
            user is not an administrator of it
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/404Error'
              examples:
                Organization not found:
                  value:
                    result: error
                    code: ORGANIZATION_NOT_FOUND
                    description: Organization not found for id='no-such-organization'
                No access to the organization:
                  value:
                    result: error
                    code: ORGANIZATION_NOT_FOUND
                    description: Organization not found
components:
  schemas:
    ArrayOfAdminApiUsers:
      type: object
      properties:
        meta:
          type: object
          properties:
            count:
              type: integer
              description: Number of users returned in this response page.
            total:
              type: integer
              description: Total number of users of the organization across all pages.
          required:
            - count
            - total
        data:
          type: array
          items:
            $ref: '#/components/schemas/AdminApiUser'
      required:
        - meta
        - data
    400Error:
      type: object
      properties:
        result:
          type: string
        code:
          type: string
        description:
          type: string
    404Error:
      type: object
      properties:
        result:
          type: string
        code:
          type: string
        description:
          type: string
      example:
        result: error
        code: ORGANIZATION_NOT_FOUND
        description: 'Failed to get organization for id: {orgId}'
    AdminApiUser:
      type: object
      description: >
        A user of an organization: a person employed by the organization. Every
        property is always present; properties without a value are null.
      required:
        - id
        - externalSourceId
        - employeeId
        - title
        - firstName
        - lastName
        - email
        - mobilePhone
        - endDate
        - ssn
        - department
        - customDimensionPresetValues
        - language
        - bankAccountNumber
        - IBAN
        - BIC
        - lastInvitationDate
        - dateCreated
        - isAdministrator
      properties:
        id:
          $ref: '#/components/schemas/Uuid'
        externalSourceId:
          type:
            - string
            - 'null'
          description: >
            String. Identifier of the user in an external system, set by an
            integration. Unique within the client application. Null when not
            set.
        employeeId:
          type:
            - string
            - 'null'
          description: >-
            String. The user's employee number in the organization. Null when
            not set.
        title:
          type:
            - string
            - 'null'
          description: String. The user's job title. Null when not set.
        firstName:
          type: string
          description: String. The user's first name.
        lastName:
          type: string
          description: String. The user's last name.
        email:
          type: string
          format: email
          description: String. The user's email address, also used to log in.
        mobilePhone:
          type:
            - string
            - 'null'
          description: >
            String. The user's mobile phone number as entered, usually in
            international format (e.g. `+46701234567`). Null when not set.
        endDate:
          type:
            - string
            - 'null'
          format: date-time
          description: >
            ISO-8601 date-time in UTC (`yyyy-MM-ddTHH:mm:ssZ`). The date the
            user's employment ends. Null when the employment has no end date.
        ssn:
          type:
            - string
            - 'null'
          description: >
            String. The user's personal identity number (social security
            number), as stored. A number entered by the user is stored
            normalized, for Swedish numbers without separator and century digits
            (e.g. `1212121212`). Null when not set.
        department:
          type:
            - object
            - 'null'
          description: >-
            The department (organizational unit) the user belongs to. Null when
            the user is not placed in a department.
          required:
            - id
            - externalSourceId
          properties:
            id:
              type: string
              description: >-
                String. The department's ID, as returned in `id` by the
                department endpoints.
            externalSourceId:
              type:
                - string
                - 'null'
              description: >-
                String. Identifier of the department in an external system, set
                by an integration. Null when not set.
        customDimensionPresetValues:
          type: array
          description: >
            Custom dimension values preset on the user, used as defaults on the
            user's expenses. Excludes values belonging to deleted dimension
            definitions. Empty when none are set.
          items:
            $ref: '#/components/schemas/AdminApiCustomDimensionPresetValue'
        language:
          type:
            - string
            - 'null'
          description: >
            String. The user's language and region as a locale code
            (`language_COUNTRY`, e.g. `en_GB`, `sv_SE`). Null when the user has
            not chosen a language, in which case the organization's language
            applies.
        bankAccountNumber:
          type:
            - string
            - 'null'
          description: >-
            String. The user's bank account number for reimbursements. Null when
            not set.
        IBAN:
          type:
            - string
            - 'null'
          description: >-
            String. The user's International Bank Account Number for
            reimbursements. Null when not set.
        BIC:
          type:
            - string
            - 'null'
          description: >-
            String. The Bank Identifier Code (SWIFT code) of the user's bank.
            Null when not set.
        lastInvitationDate:
          type:
            - string
            - 'null'
          format: date-time
          description: >
            ISO-8601 date-time in UTC (`yyyy-MM-ddTHH:mm:ssZ`). When the user
            was last sent an invitation email. Null when the user has not been
            invited, or has since activated their account.
        dateCreated:
          type: string
          format: date-time
          description: >-
            ISO-8601 date-time in UTC (`yyyy-MM-ddTHH:mm:ssZ`). When the user
            was added to the organization.
        isAdministrator:
          type: boolean
          description: Boolean. True when the user is an administrator of the organization.
    Uuid:
      type: string
      pattern: ^[0-9a-fA-F]{32}$
      description: UUID without dashes (32-character hex string)
    AdminApiCustomDimensionPresetValue:
      type: object
      required:
        - id
        - dimensionDefinitionId
      properties:
        id:
          type: string
          description: Unique identifier of the preset value.
        dimensionDefinitionId:
          type: string
          description: >-
            The ID of the custom dimension definition this preset value belongs
            to.
        presetListValueId:
          type:
            - string
            - 'null'
          description: >-
            The ID of the selected list value, when the dimension uses a list of
            values. Null when a free-text preset is used instead.
        presetListValueText:
          type:
            - string
            - 'null'
          description: >-
            Display text of the selected list value. Null when a free-text
            preset is used instead.
        presetStringValue:
          type:
            - string
            - 'null'
          description: >-
            Free-text preset value, when the dimension does not use a list of
            values. Null when a list value is used instead.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````