Agenda de Signatários
Listar grupos de signatários
Lista os grupos de contatos cadastrados no projeto, com seus membros.
GET
/
signer
/
v1
/
signer-contact-groups
Listar grupos de signatários
curl --request GET \
--url https://api.valid.com/signer/v1/signer-contact-groups \
--header 'x-api-key: <api-key>'import requests
url = "https://api.valid.com/signer/v1/signer-contact-groups"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.valid.com/signer/v1/signer-contact-groups', 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.valid.com/signer/v1/signer-contact-groups",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <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.valid.com/signer/v1/signer-contact-groups"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<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.valid.com/signer/v1/signer-contact-groups")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.valid.com/signer/v1/signer-contact-groups")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_bodyHTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"uuid": "6ba7b820-9dad-11d1-80b4-00c04fd430c9",
"name": "Diretoria",
"members": [
{
"uuid": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
"name": "João Silva",
"cpf": "12345678901",
"email": "joao@empresa.com"
},
{
"uuid": "6ba7b811-9dad-11d1-80b4-00c04fd430c8",
"name": "Maria Santos",
"cpf": "98765432109",
"email": "maria@empresa.com"
}
],
"createdAt": "2025-07-27T10:30:00Z",
"updatedAt": "2025-07-27T10:30:00Z"
}
],
"total": 1,
"page": 1,
"perPage": 20
}
Lista os grupos de signatários do seu projeto. Cada grupo contém uma lista ordenada de contatos que podem ser adicionados em massa ao criar envelopes.
Autenticação:
x-api-key no header. Também aceita Authorization: Bearer.
Parâmetros
string
Busca por nome do grupo (case-insensitive).
integer
Número da página (padrão: 1).
integer
Itens por página (padrão: 20, máximo: 100).
Respostas
array
Lista de grupos com seus membros.
integer
Total de grupos.
integer
Página atual.
integer
Itens por página.
Erros
Veja Autenticação e erros.- 401: API key inválida.
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"uuid": "6ba7b820-9dad-11d1-80b4-00c04fd430c9",
"name": "Diretoria",
"members": [
{
"uuid": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
"name": "João Silva",
"cpf": "12345678901",
"email": "joao@empresa.com"
},
{
"uuid": "6ba7b811-9dad-11d1-80b4-00c04fd430c8",
"name": "Maria Santos",
"cpf": "98765432109",
"email": "maria@empresa.com"
}
],
"createdAt": "2025-07-27T10:30:00Z",
"updatedAt": "2025-07-27T10:30:00Z"
}
],
"total": 1,
"page": 1,
"perPage": 20
}
Exemplo
curl -X GET "https://api.valid.com/signer/v1/signer-contact-groups?search=diretoria" \
-H "x-api-key: YOUR_API_KEY"
Importante
- Escopo por projeto: grupos são por projeto — você só vê os do seu.
- Ordem dos membros: preservada (importante para fluxos sequenciais).
Relacionado
GET .../signer-contact-groups/:uuid— detalhe de um grupoPOST .../signer-contact-groups— criar grupo
⌘I
Listar grupos de signatários
curl --request GET \
--url https://api.valid.com/signer/v1/signer-contact-groups \
--header 'x-api-key: <api-key>'import requests
url = "https://api.valid.com/signer/v1/signer-contact-groups"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.valid.com/signer/v1/signer-contact-groups', 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.valid.com/signer/v1/signer-contact-groups",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <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.valid.com/signer/v1/signer-contact-groups"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<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.valid.com/signer/v1/signer-contact-groups")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.valid.com/signer/v1/signer-contact-groups")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_bodyHTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"uuid": "6ba7b820-9dad-11d1-80b4-00c04fd430c9",
"name": "Diretoria",
"members": [
{
"uuid": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
"name": "João Silva",
"cpf": "12345678901",
"email": "joao@empresa.com"
},
{
"uuid": "6ba7b811-9dad-11d1-80b4-00c04fd430c8",
"name": "Maria Santos",
"cpf": "98765432109",
"email": "maria@empresa.com"
}
],
"createdAt": "2025-07-27T10:30:00Z",
"updatedAt": "2025-07-27T10:30:00Z"
}
],
"total": 1,
"page": 1,
"perPage": 20
}