List custom dimension values

GET

organizations

{organizationId}

customdimensions

{definitionId}

values

List custom dimension values

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

import requests

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

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}/customdimensions/{definitionId}/values', 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}/customdimensions/{definitionId}/values",
  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}/customdimensions/{definitionId}/values"

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

}

HttpResponse<String> response = Unirest.get("https://stage-api.findity.com/api/v1/admin/organizations/{organizationId}/customdimensions/{definitionId}/values")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

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

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": {
    "count": 2,
    "total": 2
  },
  "data": [
    {
      "id": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4",
      "value": "Marketing",
      "sortOrder": 0,
      "startDate": null,
      "endDate": null
    },
    {
      "id": "b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5",
      "value": "Sales",
      "sortOrder": 1,
      "startDate": "2024-01-01T00:00:00Z",
      "endDate": "2024-12-31T23:59:59Z"
    }
  ]
}

{
  "result": "error",
  "description": "Organization not found or access denied"
}

{
  "result": "error",
  "code": "CUSTOM_DIMENSION_DEFINITION_NOT_FOUND",
  "description": "Custom dimension definition 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"

definitionId

string

required

String. The ID of the custom dimension definition whose values to list, as returned in the id field of the GET definition response.

Example:

"abc123def456abc123def456abc123de"

Query Parameters

searchText

string

String. Filters values by a partial, case-insensitive match on the display text.

Example:

"Mark"

sort

string

String. Sort order for the results. Format: field:direction. Supported fields: value, sortOrder, startDate, endDate. Supported directions: asc, desc. Defaults to sortOrder:asc.

Example:

"sortOrder:asc"

locale

string

String. Locale code in language_REGION format (e.g. sv_SE, en_GB, de_DE). Only applies when sorting by value. Determines the collation used for alphabetical ordering of text values in natural sort. Defaults to sv_SE. Unknown locale codes fall back to Unicode ordering.

Example:

"sv_SE"

max

integer

default:10

Integer. Maximum number of results to return per page.

Required range: 1 <= x <= 1000

offset

integer

default:0

Integer. Zero-based offset of the first result to return. Used for pagination.

Required range: x >= 0

Response

meta

object

required

Hide child attributes

meta.count

integer

required

Number of dimension values returned in this response page.

meta.total

integer

required

Total number of dimension values matching the query across all pages.

data

object[]

required

Hide child attributes

data.id

string

required

Unique identifier of the dimension value.

data.value

string

required

Display text of the dimension value.

data.sortOrder

integer | null

Sort position of the value within the list. Null when not set.

data.startDate

string<date-time> | null

Date from which this value is active. Null when not set.

data.endDate

string<date-time> | null

Date until which this value is active. Null when not set.

⌘I

List custom dimension values

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

import requests

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

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}/customdimensions/{definitionId}/values', 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}/customdimensions/{definitionId}/values",
  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}/customdimensions/{definitionId}/values"

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

}

HttpResponse<String> response = Unirest.get("https://stage-api.findity.com/api/v1/admin/organizations/{organizationId}/customdimensions/{definitionId}/values")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

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

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": {
    "count": 2,
    "total": 2
  },
  "data": [
    {
      "id": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4",
      "value": "Marketing",
      "sortOrder": 0,
      "startDate": null,
      "endDate": null
    },
    {
      "id": "b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5",
      "value": "Sales",
      "sortOrder": 1,
      "startDate": "2024-01-01T00:00:00Z",
      "endDate": "2024-12-31T23:59:59Z"
    }
  ]
}

{
  "result": "error",
  "description": "Organization not found or access denied"
}

{
  "result": "error",
  "code": "CUSTOM_DIMENSION_DEFINITION_NOT_FOUND",
  "description": "Custom dimension definition not found"
}

Authentication

Findity Expense API

Findity Admin API

Findity Admin API V0

Findity Connect API

List custom dimension values

Authorizations

Path Parameters

Query Parameters

Response