Listar links de convite

Endpoint: GET /unified/accounts/sellers/{sellers_pk}/invitation-links/

Autenticação: JWT obrigatório ou Chave de API aceita

Um link de convite é um identificador curto e compartilhável que preenche previamente o formulário de cadastro de seller. Quando o convidado utiliza o link para se cadastrar (via Criar conta ou pelo fluxo público), a nova conta herda um subconjunto configurável dos campos predefinidos no link: agent, n1_distributor, n2_distributor, plan e um parent opcional. Se parent estiver definido, a nova conta é criada como sub-conta do pai (seu type é rebaixado de SELLER_* para SUB_SELLER_*). Este endpoint lista os links cujo creator é igual a sellers_pk. A ordenação é por created_at decrescente.

Parâmetros de path

string (uuid)

required

Identificador da conta unificada — criadora dos links de convite.

Parâmetros de query

string

Busca por substring (case-insensitive) em name e short_id.

Resposta

Retorna um array de links de convite.

string (uuid)

string

Código alfanumérico curto (8 caracteres) usado como identificador público do link. Somente leitura.

string

Rótulo livre para o link, exibido no painel.

object

Projeção {id, display_name, type} da conta dona do link.

object | null

Projeção {id, display_name, type}. Agente predefinido para o split da nova conta.

object | null

Projeção {id, display_name, type}. Distribuidor N1 predefinido.

object | null

Projeção {id, display_name, type}. Distribuidor N2 predefinido.

object | null

Plano de split que será aplicado. Aninhado como {id, name, ...}.

object | null

Projeção {id, display_name, type}. Se definido, cadastros realizados pelo link viram sub-contas deste pai.

string

[
  {
    "id": "44aa11b2-9c70-4f5b-8e21-12c8f7d9b1a2",
    "short_id": "k3p9q1xy",
    "name": "Força de vendas – Região SP",
    "creator": { "id": "9b1f0d2a-...", "display_name": "ACME Comércio LTDA", "type": "SELLER_PJ" },
    "agent": { "id": "ag-1111-...", "display_name": "Agente A", "type": "SELLER_PJ" },
    "n1_distributor": null,
    "n2_distributor": null,
    "plan": { "id": "pl-1111-...", "name": "Plano Padrão" },
    "parent": null,
    "created_at": "2025-04-12T10:00:00.000000Z",
    "updated_at": "2025-04-12T10:00:00.000000Z"
  }
]

Erros

Status	Quando
`401`	Token ausente ou inválido.
`403`	Solicitante não tem acesso a `sellers_pk` (quando a conta existe mas o solicitante não tem acesso, a resposta é uma lista vazia em vez de 403; superusuários sempre veem tudo).
`404`	`sellers_pk` não existe.

Exemplos

curl https://api.dlpay.cloud/unified/accounts/sellers/9b1f0d2a-2b40-4f3e-9c11-c2c0a1b3e711/invitation-links/ \
  -H "Authorization: Bearer $ACCESS_TOKEN"

import requests

response = requests.get(
    f"https://api.dlpay.cloud/unified/accounts/sellers/{seller_id}/invitation-links/",
    headers={"Authorization": f"Bearer {access_token}"},
)
links = response.json()

const response = await fetch(
  `https://api.dlpay.cloud/unified/accounts/sellers/${sellerId}/invitation-links/`,
  { headers: { Authorization: `Bearer ${accessToken}` } },
);
const links = await response.json();

Início

Autenticação e usuários

Vendedores

Vendas

Planos

Contas unificadas

Eventos

Assinaturas

Contas virtuais

Integrações do vendedor

Listar links de convite

Parâmetros de path

Parâmetros de query

Resposta

Erros

Exemplos

​Parâmetros de path

​Parâmetros de query

​Resposta

​Erros

​Exemplos

Parâmetros de path

Parâmetros de query

Resposta

Erros

Exemplos