Skip to main content
GET
/
company
Get company information
curl --request GET \
  --url https://api.firma.dev/functions/v1/signing-request-api/company \
  --header 'Authorization: <api-key>'
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Acme Corporation",
  "language": "en",
  "account_owner": "John Doe",
  "account_owner_email": "john@acme.com",
  "website": "https://acme.com",
  "icon_url": "https://acme.com/logo.png",
  "credits": 1000,
  "created_date": "2024-01-15T10:30:00Z",
  "updated_date": "2024-03-20T14:25:00Z"
}

Authorizations

​
Authorization
string
header
required

API key for authentication. Use your API key directly without any prefix (e.g., 'your-api-key'). Bearer prefix is optional but not required.

Response

Company information retrieved successfully

​
id
string<uuid>

Unique identifier for the company

​
name
string

Company name

Maximum string length: 255
​
language
enum<string>
default:en

Default language for the company

Available options:
en,
es,
it,
pt,
fr,
de,
el,
ru,
pl
​
account_owner
string

Name of the account owner

Maximum string length: 255
​
account_owner_email
string<email>

Email address of the account owner

​
website
string<uri> | null

Company website URL

​
icon_url
string<uri> | null

URL to company icon/logo

​
credits
integer
read-only

Available credits for the company (read-only, managed internally)

Required range: x >= 0
​
created_date
string<date-time>

Company account creation timestamp

​
updated_date
string<date-time>

Company account last update timestamp

​
color_primary
string | null

Primary color override (#rrggbb hex). Null uses Firma defaults.

Example:

"#2563eb"

​
color_primary_fg
string | null

Primary foreground color override. Null uses Firma defaults.

Example:

"#ffffff"

​
color_background
string | null

Background color override. Null uses Firma defaults.

Example:

"#0f172a"

​
color_foreground
string | null

Foreground/text color override. Null uses Firma defaults.

Example:

"#ffffff"

​
color_card
string | null

Card background color override. Null uses Firma defaults.

Example:

"#22222a"

​
color_border
string | null

Border color override. Null uses Firma defaults.

Example:

"#3b3b3b"