Skip to main content
GET
This tenant.

Headers

Range
string

Limiting and Pagination

Range-Unit
string
default:items

Limiting and Pagination

Prefer
enum<string>

Preference

Available options:
count=none

Query Parameters

organization_id
string
name
string
code
string
status
string
contact_email
string
contact_phone
string
address_line1
string
address_line2
string
city
string
postal_code
string
state_province_id
string
tax_identifier
string
country_id
string
default_currency_id
string
functional_currency_id
string
reporting_currency_id
string
default_language_id
string
default_locale_id
string
default_timezone
string
ask_language_at_first_sign_in
string
planning_horizon_days
string
allow_negative_stock
string
warranty_override_policy
string
display_name
string
display_name_override
string
cover_headline
string
cover_body
string
support_email
string
support_url
string
hide_platform_branding
string
hide_email_brand_header
string
print_logo_width_dots
string
print_logo_height_dots
string
print_logo_bits
string
has_logo_dark
string
has_icon
string
icon_width_px
string
icon_height_px
string
icon_is_app_icon
string
app_icon_minimum_px
string
has_cover
string
asset_version
string
subdomain_host
string
primary_host
string
active_custom_domains
string
pending_custom_domains
string
default_currency_code
string
default_currency_symbol
string
default_currency_decimal_places
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

Response

OK

active_custom_domains
integer<bigint>
address_line1
string<character varying>
Maximum string length: 200
address_line2
string<character varying>
Maximum string length: 200
allow_negative_stock
boolean<boolean>
app_icon_minimum_px
integer<integer>
ask_language_at_first_sign_in
boolean<boolean>
asset_version
string<text>
city
string<character varying>
Maximum string length: 120
code
string<character varying>
Maximum string length: 50
contact_email
string<public.citext>
contact_phone
string<character varying>
Maximum string length: 40
country_id
string<uuid>
cover_body
string<character varying>
Maximum string length: 400
cover_headline
string<character varying>
Maximum string length: 120
default_currency_code
string<character varying>
Maximum string length: 3
default_currency_decimal_places
integer<smallint>
default_currency_id
string<uuid>

Note: This is a Foreign Key to asset_cost_to_keep.currency_id.

default_currency_symbol
string<character varying>
Maximum string length: 10
default_language_id
string<uuid>
default_locale_id
string<uuid>
default_timezone
string<character varying>
Maximum string length: 100
display_name
string<character varying>
display_name_override
string<character varying>
Maximum string length: 120
functional_currency_id
string<uuid>

Note: This is a Foreign Key to asset_cost_to_keep.currency_id.

has_cover
boolean<boolean>
has_icon
boolean<boolean>
has_logo_dark
boolean<boolean>
hide_email_brand_header
boolean<boolean>
hide_platform_branding
boolean<boolean>
icon_height_px
integer<integer>
icon_is_app_icon
boolean<boolean>
icon_width_px
integer<integer>
Maximum string length: 250
name
string<character varying>
Maximum string length: 200
organization_id
string<uuid>

Note: This is a Primary Key.

pending_custom_domains
integer<bigint>
planning_horizon_days
integer<integer>
postal_code
string<character varying>
Maximum string length: 30
primary_host
string<text>
print_logo_bits
string<text>
print_logo_height_dots
integer<integer>
print_logo_width_dots
integer<integer>
reporting_currency_id
string<uuid>

Note: This is a Foreign Key to asset_cost_to_keep.currency_id.

state_province_id
string<uuid>
status
string<character varying>
Maximum string length: 30
subdomain_host
string<text>
support_email
string<public.citext>
support_url
string<character varying>
Maximum string length: 300
tax_identifier
string<character varying>
Maximum string length: 60
warranty_override_policy
string<character varying>
Maximum string length: 20