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.

GET

organizations

{organizationId}

users

List users

curl --request GET \
  --url https://stage-api.findity.com/api/v1/admin/organizations/{organizationId}/users \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://stage-api.findity.com/api/v1/admin/organizations/{organizationId}/users"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://stage-api.findity.com/api/v1/admin/organizations/{organizationId}/users', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://stage-api.findity.com/api/v1/admin/organizations/{organizationId}/users",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://stage-api.findity.com/api/v1/admin/organizations/{organizationId}/users"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://stage-api.findity.com/api/v1/admin/organizations/{organizationId}/users")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

organizationId

string

required

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.

Query Parameters

sort

string[]

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.

max

integer

default:10

Optional. Integer. Maximum number of users to return in one page. Must be between 1 and 1000. Defaults to 10.

Required range: 1 <= x <= 1000

offset

integer

default:0

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.

Required range: x >= 0

Response

meta

object

required

Hide child attributes

meta.count

integer

required

Number of users returned in this response page.

meta.total

integer

required

Total number of users of the organization across all pages.

data

object[]

required

Hide child attributes

data.id

string

required

UUID without dashes (32-character hex string)

Pattern: ^[0-9a-fA-F]{32}$

data.externalSourceId

string | null

required

String. Identifier of the user in an external system, set by an integration. Unique within the client application. Null when not set.

data.employeeId

string | null

required

String. The user's employee number in the organization. Null when not set.

data.title

string | null

required

String. The user's job title. Null when not set.

data.firstName

string

required

String. The user's first name.

data.lastName

string

required

String. The user's last name.

data.email

string<email>

required

String. The user's email address, also used to log in.

data.mobilePhone

string | null

required

String. The user's mobile phone number as entered, usually in international format (e.g. +46701234567). Null when not set.

data.endDate

string<date-time> | null

required

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.

data.ssn

string | null

required

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.

data.department

object | null

required

The department (organizational unit) the user belongs to. Null when the user is not placed in a department.

Hide child attributes

data.department.id

string

required

String. The department's ID, as returned in id by the department endpoints.

data.department.externalSourceId

string | null

required

String. Identifier of the department in an external system, set by an integration. Null when not set.

data.customDimensionPresetValues

object[]

required

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.

Hide child attributes

data.customDimensionPresetValues.id

string

required

Unique identifier of the preset value.

data.customDimensionPresetValues.dimensionDefinitionId

string

required

The ID of the custom dimension definition this preset value belongs to.

data.customDimensionPresetValues.presetListValueId

string | null

The ID of the selected list value, when the dimension uses a list of values. Null when a free-text preset is used instead.

data.customDimensionPresetValues.presetListValueText

string | null

Display text of the selected list value. Null when a free-text preset is used instead.

data.customDimensionPresetValues.presetStringValue

string | null

Free-text preset value, when the dimension does not use a list of values. Null when a list value is used instead.

data.language

string | null

required

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.

data.bankAccountNumber

string | null

required

String. The user's bank account number for reimbursements. Null when not set.

data.IBAN

string | null

required

String. The user's International Bank Account Number for reimbursements. Null when not set.

data.BIC

string | null

required

String. The Bank Identifier Code (SWIFT code) of the user's bank. Null when not set.

data.lastInvitationDate

string<date-time> | null

required

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.

data.dateCreated

string<date-time>

required

ISO-8601 date-time in UTC (yyyy-MM-ddTHH:mm:ssZ). When the user was added to the organization.

data.isAdministrator

boolean

required

Boolean. True when the user is an administrator of the organization.

⌘I

List users

curl --request GET \
  --url https://stage-api.findity.com/api/v1/admin/organizations/{organizationId}/users \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://stage-api.findity.com/api/v1/admin/organizations/{organizationId}/users"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://stage-api.findity.com/api/v1/admin/organizations/{organizationId}/users', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://stage-api.findity.com/api/v1/admin/organizations/{organizationId}/users",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://stage-api.findity.com/api/v1/admin/organizations/{organizationId}/users"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://stage-api.findity.com/api/v1/admin/organizations/{organizationId}/users")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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
    }
  ]
}

Authentication

Findity Expense API

Findity Admin API

Findity Admin API V0

Findity Connect API

List users

Authorizations

Path Parameters

Query Parameters

Response