Skip to main content
GET
Get the current entity

Authorizations

Authorization
string
header
required

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

Headers

x-finops-version
string<date>
required

Response

Successful Response

A schema for a response after creation of an entity of different types

id
string<uuid>
required

UUID entity ID

created_at
string<date-time>
required

UTC datetime

updated_at
string<date-time>
required

UTC datetime

address
object
required

An address description of the entity

organization
object
required

A set of metadata describing an organization

status
enum<string>
required

record status, 'active' by default

Available options:
active,
inactive,
deleted
type
string
required

A type for an organization

Allowed value: "organization"
email
string | null

An official email address of the entity

logo
object | null

A logo image of the entity

phone
string | null

A phone number of the entity

Maximum string length: 100
registration_authority
string | null

(Germany only) The name of the local district court (Amtsgericht) where the entity is registered. Required if registration_number is provided.

Required string length: 1 - 100
Example:

"Amtsgericht Charlottenburg"

registration_number
string | null

(Germany only) The entity's commercial register number (Handelsregisternummer) in the German Commercial Register, if available.

Required string length: 1 - 100
Example:

"HRB 202324"

tax_id
string | null

The entity's taxpayer identification number or tax ID. This field is required for entities that are non-VAT registered.

Maximum string length: 30
website
string<uri> | null

A website of the entity

Required string length: 1 - 2083