Saltar al contenido principal
GET
/
company
/
domains
/
{id}
@firma-dev/sdk
import { FirmaClient } from "@firma-dev/sdk";

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

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

url = "https://api.firma.dev/functions/v1/signing-request-api/company/domains/{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/company/domains/{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/company/domains/{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/company/domains/{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/company/domains/{id}")
.header("Authorization", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.firma.dev/functions/v1/signing-request-api/company/domains/{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": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "domain": "<string>",
  "is_primary": true,
  "verification_token": "<string>",
  "resend_domain_id": "<string>",
  "dns_records": [
    {
      "name": "<string>",
      "value": "<string>",
      "ttl": "<string>",
      "priority": 123
    }
  ],
  "date_created": "2023-11-07T05:31:56Z",
  "date_changed": "2023-11-07T05:31:56Z"
}
{
"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
}
}

Autorizaciones

Authorization
string
header
requerido

Clave API para autenticación. Usa tu clave API directamente sin ningún prefijo (por ejemplo, 'your-api-key'). El prefijo Bearer es opcional pero no obligatorio.

Parámetros de ruta

id
string<uuid>
requerido

ID del dominio

Respuesta

Dominio obtenido correctamente

Configuración de dominio de correo para enviar correos de Solicitud de Firma

id
string<uuid>
requerido

Identificador único del dominio

domain
string
requerido

El nombre de dominio (por ejemplo, 'example.com')

verification_status
enum<integer>
requerido

Estado de verificación de propiedad del dominio: 0=pendiente, 1=propiedad verificada (registro TXT confirmado), 2=finalizado (registrado con el proveedor de correo)

Opciones disponibles:
0,
1,
2
domain_status
enum<integer>
requerido

Estado de envío de correo: 0=registros DNS pendientes de verificación, 1=totalmente verificado y listo para enviar

Opciones disponibles:
0,
1
is_primary
boolean

Si este es el dominio primario para enviar correos desde este Espacio de Trabajo

verification_token
string

Token para agregar como registro TXT para la verificación de propiedad del dominio. Solo se devuelve cuando verification_status=0.

resend_domain_id
string | null

ID de dominio del proveedor de correo externo (uso interno)

dns_records
object[] | null

Registros DNS requeridos para el envío de correo. Solo se devuelven después de la finalización del dominio (verification_status=2).

date_created
string<date-time>

Marca de tiempo de creación del dominio

date_changed
string<date-time>

Marca de tiempo de la última actualización del dominio