Get organization

GET

organizations

{organizationId}

Get organization

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

import requests

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

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}', 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}",
  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}"

	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}")

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

{
  "id": "11adfe2a080040e3892ffb89c21ec44e",
  "externalSourceId": "ext-acme-001",
  "name": "Example Ltd.",
  "vat": "123456-1234",
  "phone": "+46701234567",
  "status": "NORMAL",
  "type": "COMPANY",
  "dateCreated": "2024-01-15T09:30:00Z",
  "lastUpdated": "2024-06-01T14:22:00Z",
  "clientApplicationId": "ca1234567890abcdef1234567890abcd",
  "personId": "8ab28c4f84d89c570184e1da2bf10540",
  "reportReviewOnPartner": false,
  "sendEventToExternalSystemPartnerLevel": false,
  "sendEventToExternalSystem": false,
  "automaticSetupEnabled": true,
  "editUsersDisabled": false,
  "automaticSetupCompleted": false,
  "supportAccessEndDate": null,
  "policyUrl": null,
  "address": {
    "street1": "Storgatan 1",
    "city": "Stockholm",
    "postalCode": "11122",
    "countryName": "Sweden",
    "countryIso2Code": "SE"
  },
  "partner": {
    "partnerId": "abc123def456abc123def456abc123de",
    "partnerName": "Acme Partner AB",
    "partnerCode": "ACME",
    "payedByPartner": true
  }
}

{
  "result": "error",
  "code": "ORGANIZATION_NOT_FOUND",
  "description": "Organization not found"
}

Authorizations

Authorization

string

header

required

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

Path Parameters

organizationId

string

required

String. The organization's internal ID (32-character hex string) or its externalSourceId. When the value matches the format of an internal ID, the internal ID takes precedence.

Example:

"11adfe2a080040e3892ffb89c21ec44e"

Query Parameters

include

string

String. Comma-separated list of optional data sections to include in the response. Accepted values: address, invoiceDetails, settings, design, partner. Sections not listed here are omitted from the response.

Example:

"address,partner"

Response

string

required

Unique internal identifier of the organization. 32-character hex string. Read-only; assigned by the server on creation.

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

name

string

required

Display name of the organization.

status

enum<string>

required

Lifecycle status of the organization.

Available options:

NORMAL,

NEW,

INCOMPLETE

dateCreated

string<date-time>

required

ISO 8601 timestamp of when the organization was created.

lastUpdated

string<date-time>

required

ISO 8601 timestamp of when the organization was last modified.

reportReviewOnPartner

boolean

required

Whether expense report review is delegated to partner level rather than handled within this organization.

sendEventToExternalSystemPartnerLevel

boolean

required

Whether events are forwarded to the external system at partner level (rather than organization level).

sendEventToExternalSystem

boolean

required

Whether events from this organization are sent to the external system.

externalSourceId

string | null

Caller-supplied identifier used to address this organization from an external system. Null when no external source ID has been set.

vat

string | null

Organization registration number (VAT/company number).

phone

string | null

Main phone number of the organization. Null when no phone number has been set.

type

enum<string>

read-only

What kind of organization this is. COMPANY is a real organization, TEMPLATE is a template organization usable as templateOrganizationId when creating one. Template organizations have no employees, partner or design, so design comes back empty and meta is left out for them.

Available options:

COMPANY,

TEMPLATE

clientApplicationId

string

ID of the client application (partner integration) that created this organization.

personId

string

ID of the person that administers this organization. When several persons are linked to the authenticated account, this is the specific person holding the administrator role for this organization, which is not necessarily the logged in person. Falls back to the logged in person when no separate person is found.

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

editUsersDisabled

boolean

Whether users of the organization are managed by an integration. When true, organization administrators can't add, delete or restore users, or edit them in the admin UI. The admin UI is locked for all users; through the API, developers and API key users (integrations) are not affected. Copied from the template when the organization is created.

automaticSetupEnabled

boolean | null

Whether the organization is set up automatically from its partner template. Always present, and null when the flag has never been set.

automaticSetupCompleted

boolean | null

Whether the automatic setup has finished. Always present, and null when the flag has never been set; a client that drives onboarding treats enabled and not completed as setup still pending.

supportAccessEndDate

string<date-time> | null

ISO 8601 timestamp until which Findity support staff has elevated access to this organization. Null when no support access window is active.

policyUrl

string | null

Pre-signed URL to the organization's active policy document. Null when no policy document is configured.

address

object | null

Postal address of the organization. Only present when include=address is requested. Null when the organization has no address on record.

Hide child attributes

address.street1

string | null

First line of the street address.

address.city

string | null

City name.

address.postalCode

string | null

Postal or ZIP code.

address.countryName

string | null

Full country name.

address.countryIso2Code

string | null

ISO 3166-1 alpha-2 country code (2-letter uppercase, e.g. SE).

invoiceDetails

object | null

Invoice address and billing contact. Only present when include=invoiceDetails is requested. Null when the organization has no invoice details on record.

Hide child attributes

invoiceDetails.street1

string | null

First line of the invoice street address.

invoiceDetails.city

string | null

City name.

invoiceDetails.postalCode

string | null

Postal or ZIP code.

invoiceDetails.countryName

string | null

Full country name.

invoiceDetails.countryIso2Code

string | null

ISO 3166-1 alpha-2 country code (2-letter uppercase, e.g. SE).

invoiceDetails.emailAddress

string | null

Email address for invoice delivery.

settings

object

Organization-specific configuration settings. Only present when include=settings is requested. Empty object when the organization has no custom settings configured.

design

object

Branding and visual design configuration for this organization, resolved by merging client application, partner and organization level design. Only present when include=design is requested. Empty object when the organization has no custom design configured.

Hide child attributes

design.accentColor

string

Hex color code, either three or six digits (e.g. #1A73E8).

Pattern: ^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$

design.darkAccentColor

string

Hex color code, either three or six digits (e.g. #0B4FA8).

Pattern: ^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$

design.secondaryAccentColor

string

Hex color code, either three or six digits. Defaults to accentColor when not configured.

Pattern: ^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$

design.secondaryDarkAccentColor

string

Hex color code, either three or six digits. Defaults to darkAccentColor when not configured.

Pattern: ^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$

design.textOnAccentColor

string

Six digit hex color code, always #FFFFFF or #000000. Derived from accentColor for readable text on that background.

Pattern: ^#[0-9A-Fa-f]{6}$

design.textOnDarkAccentColor

string

Six digit hex color code, always #FFFFFF or #000000. Derived from darkAccentColor for readable text on that background.

Pattern: ^#[0-9A-Fa-f]{6}$

design.textOnSecondaryAccentColor

string

Six digit hex color code, always #FFFFFF or #000000. Derived from secondaryAccentColor for readable text on that background.

Pattern: ^#[0-9A-Fa-f]{6}$

design.textOnSecondaryDarkAccentColor

string

Six digit hex color code, always #FFFFFF or #000000. Derived from secondaryDarkAccentColor for readable text on that background.

Pattern: ^#[0-9A-Fa-f]{6}$

design.logoUrl

string<uri>

URL to the organization logo.

URL to the logo used in the menu.

design.iconUrl

string<uri>

URL to the organization icon.

partner

object | null

Partner affiliation details. Only present when include=partner is requested. Null when the organization has no partner association.

Hide child attributes

partner.partnerId

string | null

External ID of the partner.

partner.partnerName

string | null

Display name of the partner.

partner.partnerCode

string | null

Short code identifying the partner.

partner.payedByPartner

boolean | null

Whether this organization's Findity subscription is paid by the partner.

meta

object

Additional computed data about the organization. Only present on GET /organizations when include=meta.permissions is requested. This is per-organization metadata and is unrelated to the list level meta object that carries count and total. The name follows the include=meta.* convention used across the Findity APIs, and matches the same field on GET /v1/expense/me/organizations. Left out for template organizations, which cannot have an employee and therefore no permissions to report.

Hide child attributes

meta.permissions

object | null

What the authenticated user is allowed to do in this organization. Null when permissions cannot be resolved for the organization.

Hide child attributes

meta.permissions.canAddCard

boolean

If user can connect new credit cards.

meta.permissions.canViewExpenses

boolean

If user can view expenses, i.e. is an employee of an organization.

meta.permissions.canApprove

boolean

If user can approve expenses in the organization.

meta.permissions.canCreateExpense

boolean

If user can create expenses.

meta.permissions.canCreateReport

boolean

If user can create expense reports.

meta.permissions.canSendExpenses

boolean

If user can send in single expenses.

meta.permissions.canSendReports

boolean

If user can send expense reports.

meta.permissions.canDeleteAccount

boolean

If user is allowed to delete the account.

meta.permissions.canAdminister

boolean

If user has administration rights for the organization, allowing them to manage organization settings, members, and related configuration.

⌘I

Get organization

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

import requests

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

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}', 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}",
  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}"

	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}")

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

{
  "id": "11adfe2a080040e3892ffb89c21ec44e",
  "externalSourceId": "ext-acme-001",
  "name": "Example Ltd.",
  "vat": "123456-1234",
  "phone": "+46701234567",
  "status": "NORMAL",
  "type": "COMPANY",
  "dateCreated": "2024-01-15T09:30:00Z",
  "lastUpdated": "2024-06-01T14:22:00Z",
  "clientApplicationId": "ca1234567890abcdef1234567890abcd",
  "personId": "8ab28c4f84d89c570184e1da2bf10540",
  "reportReviewOnPartner": false,
  "sendEventToExternalSystemPartnerLevel": false,
  "sendEventToExternalSystem": false,
  "automaticSetupEnabled": true,
  "editUsersDisabled": false,
  "automaticSetupCompleted": false,
  "supportAccessEndDate": null,
  "policyUrl": null,
  "address": {
    "street1": "Storgatan 1",
    "city": "Stockholm",
    "postalCode": "11122",
    "countryName": "Sweden",
    "countryIso2Code": "SE"
  },
  "partner": {
    "partnerId": "abc123def456abc123def456abc123de",
    "partnerName": "Acme Partner AB",
    "partnerCode": "ACME",
    "payedByPartner": true
  }
}

{
  "result": "error",
  "code": "ORGANIZATION_NOT_FOUND",
  "description": "Organization not found"
}

Authentication

Findity Expense API

Findity Admin API

Findity Admin API V0

Findity Connect API

Authorizations

Path Parameters

Query Parameters

Response