Passer au contenu principal
GET
/
workspaces
/
{id}
@firma-dev/sdk
import { FirmaClient } from "@firma-dev/sdk";

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

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

url = "https://api.firma.dev/functions/v1/signing-request-api/workspaces/{id}"

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/workspaces/{id}', 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/workspaces/{id}",
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/workspaces/{id}"

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/workspaces/{id}")
.header("Authorization", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.firma.dev/functions/v1/signing-request-api/workspaces/{id}")

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": "789e4567-e89b-12d3-a456-426614174000",
  "name": "Sales Workspace",
  "protected": false,
  "api_key": "fk_a1b2c3d4e5f6g7h8i9j0",
  "created_date": "2024-01-20T09:00:00Z",
  "updated_date": "2024-01-20T09:00:00Z",
  "webhook_enabled": false,
  "webhook_secret": null,
  "webhook_secret_rotated_at": null,
  "webhook_secret_created_at": null,
  "ignore_company_webhooks": false
}
{
"error": "Unauthorized",
"message": "Invalid API key"
}
{
"error": "Not Found",
"message": "The requested resource was not found"
}
{
"error": "Rate Limit Exceeded",
"message": "Too many requests. Please wait before retrying.",
"details": {
"retry_after": 45
}
}

Autorisations

Authorization
string
header
requis

Clé API pour l'authentification. Utilisez votre clé API directement sans préfixe (par exemple, 'your-api-key'). Le préfixe Bearer est optionnel mais pas obligatoire.

Paramètres de chemin

id
string<uuid>
requis

ID de l'espace de travail

Réponse

Espace de travail récupéré avec succès

id
string<uuid>
requis

Identifiant unique de l'espace de travail

name
string
requis

Nom de l'espace de travail

Maximum string length: 255
created_date
string<date-time>
requis

Timestamp de création de l'espace de travail

protected
boolean

Les espaces de travail protégés ne peuvent pas être supprimés

api_key
string | null

Clé API en mode production pour cet espace de travail. Utilisée pour authentifier les requêtes API propres à cet espace de travail.

test_api_key
string | null

Clé API en mode test pour cet espace de travail. Les requêtes authentifiées avec cette clé ne consomment pas de crédits et produisent des demandes de signature marquées test et filigranées.

updated_date
string<date-time>

Timestamp de dernière mise à jour de l'espace de travail

webhook_enabled
boolean

Indique si les webhooks au niveau de l'espace de travail sont activés

webhook_secret
string | null

Secret de signature webhook pour cet espace de travail

webhook_secret_rotated_at
string<date-time> | null

Timestamp de la dernière rotation du secret webhook

webhook_secret_created_at
string<date-time> | null

Timestamp de la première création du secret webhook

ignore_company_webhooks
boolean

Si true, les webhooks au niveau de l'entreprise ne se déclenchent pas pour les événements de cet espace de travail

icon_url
string<uri> | null

URL publiquement accessible vers le logo de l'espace de travail. Retourne le logo propre à l'espace de travail, ou null s'il n'est pas défini (le logo de l'entreprise n'est PAS inclus comme solution de repli dans ce champ).

Exemple:

"https://ielmshcswdhuacyjlpiy.supabase.co/functions/v1/logo/workspace/company-id/workspace-id"