Skip to main content
GET
/
company
@firma-dev/sdk
import { FirmaClient } from "@firma-dev/sdk";

const firma = new FirmaClient({ apiKey: "YOUR_API_KEY" });

const response = await firma.company.getCompany();
console.log(response);
curl --request GET \
--url https://api.firma.dev/functions/v1/signing-request-api/company \
--header 'Authorization: <api-key>'
import requests

url = "https://api.firma.dev/functions/v1/signing-request-api/company"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.firma.dev/functions/v1/signing-request-api/company', 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://api.firma.dev/functions/v1/signing-request-api/company",
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: <api-key>"
],
]);

$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://api.firma.dev/functions/v1/signing-request-api/company"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.firma.dev/functions/v1/signing-request-api/company")
.header("Authorization", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.firma.dev/functions/v1/signing-request-api/company")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "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"
}
{
"error": "Unauthorized",
"message": "Invalid API key"
}
{
"error": "Rate Limit Exceeded",
"message": "Too many requests. Please wait before retrying.",
"details": {
"retry_after": 45
}
}

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

Unique identifier for the company

name
string
required

Company name

Maximum string length: 255
account_owner
string
required

Name of the account owner

Maximum string length: 255
account_owner_email
string<email>
required

Email address of the account owner

created_date
string<date-time>
required

Company account creation timestamp

language
enum<string>
default:en

Default language for the company

Available options:
en,
es,
it,
pt,
fr,
de,
el,
ru,
pl
website
string<uri> | null

Company website URL

icon_url
string<uri> | null

Publicly accessible URL to the company logo image. Returns null if no logo is set.

Example:

"https://ielmshcswdhuacyjlpiy.supabase.co/functions/v1/logo/company/3feb35a8-5aaf-4603-8b50-acd807176b38"

credits
integer
read-only

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

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

Company account last update timestamp