API de equipes

Gerencie equipes e membros. As requisições continuam sujeitas às permissões da sua conta e equipe.

Usar Autenticação da API para pedidos protegidos. Exemplos usam seus próprios IDs de recursos e um token temporário; exemplos de resposta salvos são sintéticos.

Método	Caminho	Operação
`GET`	`/v1/team`	Listar equipes
`POST`	`/v1/team`	Criar equipe
`GET`	`/v1/team/{id}`	Obter equipe
`PUT`	`/v1/team/{id}`	Atualizar equipe
`DELETE`	`/v1/team/{id}`	Excluir equipe
`GET`	`/v1/team/deployment-context`	Obter contexto de implantação
`GET`	`/v1/team/members`	Listar membros da equipe
`GET`	`/v1/team/invitations`	Listar convites da equipe
`POST`	`/v1/team/invitations`	Convide um membro da equipe
`POST`	`/v1/team/invitations/{id}/resend`	Reenviar convite da equipe
`DELETE`	`/v1/team/invitations/{id}`	Revogar convite da equipe

Listar equipes

GET /v1/team

Retorna uma lista paginada de Team

Autenticação: token bearer e o cabeçalho de equipe mostrado abaixo.

Parâmetros

Nome	Localização	Obrigatório	Descrição
`X-Tenant-ID`	cabeçalho	sim	ID da equipe ativa. Deve corresponder ao tenant vinculado a um token de diagnóstico.
`page`	consulta	não	Número da página
`per_page`	consulta	não	Itens por página

Exemplo de requisição

Defina ADIOS_API_URL=https://api.adios.dev. Para requisições protegidas, defina ADIOS_ACCESS_TOKEN e ADIOS_TEAM_ID como na início rápido. Defina quaisquer variáveis adicionais ADIOS_* variáveis dos seus próprios resultados de recursos.

curl --fail-with-body --request GET "$ADIOS_API_URL/v1/team" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Resposta: HTTP 200

Lista de Team

Campos de resposta

Campo	Tipo	Descrição
`data`	array
`data[].created_at`	inteiro	(Timestamp Unix)
`data[].deleted_at`	inteiro	(Timestamp Unix)
`data[].description`	string
`data[].owner_id`	string
`data[].parent_id`	string
`data[].status`	string	Valores permitidos: active, inactive, suspended, deleted.
`data[].team_id`	string
`data[].title`	string
`data[].updated_at`	inteiro	(Timestamp Unix)
`pagination`	objeto
`pagination.page`	inteiro	Número da página atual
`pagination.per_page`	inteiro	Número de itens por página
`pagination.total`	inteiro	Número total de itens

Exemplo ilustrativo; não é uma resposta real:

{
  "data": [
    {
      "created_at": 1791072000,
      "deleted_at": 0,
      "description": "",
      "owner_id": "000000000000000000000000001",
      "parent_id": "000000000000000000000000001",
      "status": "active",
      "team_id": "000000000000000000000000001",
      "title": "Postman example",
      "updated_at": 1791072000
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 1,
    "total": 1
  }
}

Criar equipe

POST /v1/team

Cria um novo objeto Team

Esta requisição altera dados ou inicia uma ação. Confira o destino e o corpo antes de enviá-la.

Campos da requisição (o corpo contém um exemplo editável):

Campo	Tipo	Obrigatório	Descrição
`description`	string	não	Padrão: `""`.
`owner_id`	string	sim
`parent_id`	string	não
`status`	string	sim	Valores permitidos: active, inactive, suspended, deleted. Padrão: `"active"`.
`title`	string	sim

Autenticação: token bearer e o cabeçalho de equipe mostrado abaixo.

Parâmetros

Nome	Localização	Obrigatório	Descrição
`X-Tenant-ID`	cabeçalho	sim	ID da equipe ativa. Deve corresponder ao tenant vinculado a um token de diagnóstico.

Exemplo de requisição

curl --fail-with-body --request POST "$ADIOS_API_URL/v1/team" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID" \
  -H "Content-Type: application/json" \
  --data-binary @- <<'JSON'
{
  "owner_id": "YOUR_USER_ID",
  "title": "Postman example team",
  "status": "active"
}
JSON

Substitua YOUR_* no corpo antes de enviar. O heredoc com delimitador entre aspas mantém o JSON literal.

Resposta: HTTP 201

Team criado

Campos de resposta

Campo	Tipo	Descrição
`created_at`	inteiro	(Timestamp Unix)
`deleted_at`	inteiro	(Timestamp Unix)
`description`	string
`owner_id`	string
`parent_id`	string
`status`	string	Valores permitidos: active, inactive, suspended, deleted.
`team_id`	string
`title`	string
`updated_at`	inteiro	(Timestamp Unix)

Exemplo ilustrativo; não é uma resposta real:

{
  "created_at": 1791072000,
  "deleted_at": 0,
  "description": "",
  "owner_id": "000000000000000000000000001",
  "parent_id": "000000000000000000000000001",
  "status": "active",
  "team_id": "000000000000000000000000001",
  "title": "Postman example",
  "updated_at": 1791072000
}

Obter equipe

GET /v1/team/{id}

Retorna um objeto Team

Defina team_id usando IDs das suas próprias respostas da API.

Autenticação: token bearer e o cabeçalho de equipe mostrado abaixo.

Parâmetros

Nome	Localização	Obrigatório	Descrição
`id`	caminho	sim	Identificador de recurso dos resultados da API da sua equipe.
`X-Tenant-ID`	cabeçalho	sim	ID da equipe ativa. Deve corresponder ao tenant vinculado a um token de diagnóstico.

Exemplo de requisição

curl --fail-with-body --request GET "$ADIOS_API_URL/v1/team/${ADIOS_TEAM_ID}" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Resposta: HTTP 200

Equipe

Campos de resposta

Campo	Tipo	Descrição
`created_at`	inteiro	(Timestamp Unix)
`deleted_at`	inteiro	(Timestamp Unix)
`description`	string
`owner_id`	string
`parent_id`	string
`status`	string	Valores permitidos: active, inactive, suspended, deleted.
`team_id`	string
`title`	string
`updated_at`	inteiro	(Timestamp Unix)

Exemplo ilustrativo; não é uma resposta real:

{
  "created_at": 1791072000,
  "deleted_at": 0,
  "description": "",
  "owner_id": "000000000000000000000000001",
  "parent_id": "000000000000000000000000001",
  "status": "active",
  "team_id": "000000000000000000000000001",
  "title": "Postman example",
  "updated_at": 1791072000
}

Atualizar equipe

PUT /v1/team/{id}

Atualiza um objeto Team existente

Defina team_id usando IDs das suas próprias respostas da API.

Esta requisição altera dados ou inicia uma ação. Confira o destino e o corpo antes de enviá-la.

Campos da requisição (o corpo contém um exemplo editável):

Campo	Tipo	Obrigatório	Descrição
`description`	string	não	Padrão: `""`.
`owner_id`	string	sim
`parent_id`	string	não
`status`	string	sim	Valores permitidos: active, inactive, suspended, deleted. Padrão: `"active"`.
`title`	string	sim

Autenticação: token bearer e o cabeçalho de equipe mostrado abaixo.

Parâmetros

Nome	Localização	Obrigatório	Descrição
`id`	caminho	sim	Identificador de recurso dos resultados da API da sua equipe.
`X-Tenant-ID`	cabeçalho	sim	ID da equipe ativa. Deve corresponder ao tenant vinculado a um token de diagnóstico.

Exemplo de requisição

curl --fail-with-body --request PUT "$ADIOS_API_URL/v1/team/${ADIOS_TEAM_ID}" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID" \
  -H "Content-Type: application/json" \
  --data-binary @- <<'JSON'
{
  "owner_id": "YOUR_USER_ID",
  "title": "Postman example team",
  "status": "active"
}
JSON

Substitua YOUR_* no corpo antes de enviar. O heredoc com delimitador entre aspas mantém o JSON literal.

Resposta: HTTP 200

Team atualizado

Campos de resposta

Campo	Tipo	Descrição
`created_at`	inteiro	(Timestamp Unix)
`deleted_at`	inteiro	(Timestamp Unix)
`description`	string
`owner_id`	string
`parent_id`	string
`status`	string	Valores permitidos: active, inactive, suspended, deleted.
`team_id`	string
`title`	string
`updated_at`	inteiro	(Timestamp Unix)

Exemplo ilustrativo; não é uma resposta real:

{
  "created_at": 1791072000,
  "deleted_at": 0,
  "description": "",
  "owner_id": "000000000000000000000000001",
  "parent_id": "000000000000000000000000001",
  "status": "active",
  "team_id": "000000000000000000000000001",
  "title": "Postman example",
  "updated_at": 1791072000
}

Excluir equipe

DELETE /v1/team/{id}

Exclui um objeto Team

Defina team_id usando IDs das suas próprias respostas da API.

Esta requisição altera dados ou inicia uma ação. Confira o destino e o corpo antes de enviá-la.

Autenticação: token bearer e o cabeçalho de equipe mostrado abaixo.

Parâmetros

Nome	Localização	Obrigatório	Descrição
`id`	caminho	sim	Identificador de recurso dos resultados da API da sua equipe.
`X-Tenant-ID`	cabeçalho	sim	ID da equipe ativa. Deve corresponder ao tenant vinculado a um token de diagnóstico.

Exemplo de requisição

curl --fail-with-body --request DELETE "$ADIOS_API_URL/v1/team/${ADIOS_TEAM_ID}" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Resposta: HTTP 200

O recurso foi apagado.

Campos de resposta

Campo	Tipo	Descrição
`message`	string

Exemplo ilustrativo; não é uma resposta real:

{
  "message": "Deleted successfully"
}

Obter contexto de implantação

GET /v1/team/deployment-context

Descubra as regiões de implantação disponíveis e o contexto de implantação da equipe ativa.

Autenticação: token bearer e o cabeçalho de equipe mostrado abaixo.

Parâmetros

Nome	Localização	Obrigatório	Descrição
`X-Tenant-ID`	cabeçalho	sim	ID da equipe ativa. Deve corresponder ao tenant vinculado a um token de diagnóstico.

Exemplo de requisição

curl --fail-with-body --request GET "$ADIOS_API_URL/v1/team/deployment-context" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Resposta: HTTP 200

Resposta bem sucedida. Inspecione o estado retornado para operações que iniciam trabalho assíncrono.

Um esquema completo de corpo-resposta não é publicado para esta operação personalizada. Inspecione o conteúdo e o status retornados; nenhuma carga útil é assumida aqui.

Listar membros da equipe

GET /v1/team/members

Liste os membros da equipe selecionada.

Autenticação: token bearer e o cabeçalho de equipe mostrado abaixo.

Parâmetros

Nome	Localização	Obrigatório	Descrição
`X-Tenant-ID`	cabeçalho	sim	ID da equipe ativa. Deve corresponder ao tenant vinculado a um token de diagnóstico.

Exemplo de requisição

curl --fail-with-body --request GET "$ADIOS_API_URL/v1/team/members" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Resposta: HTTP 200

Resposta bem sucedida. Inspecione o estado retornado para operações que iniciam trabalho assíncrono.

Um esquema completo de corpo-resposta não é publicado para esta operação personalizada. Inspecione o conteúdo e o status retornados; nenhuma carga útil é assumida aqui.

Listar convites da equipe

GET /v1/team/invitations

Liste os convites da equipe selecionada.

Autenticação: token bearer e o cabeçalho de equipe mostrado abaixo.

Parâmetros

Nome	Localização	Obrigatório	Descrição
`X-Tenant-ID`	cabeçalho	sim	ID da equipe ativa. Deve corresponder ao tenant vinculado a um token de diagnóstico.

Exemplo de requisição

curl --fail-with-body --request GET "$ADIOS_API_URL/v1/team/invitations" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Resposta: HTTP 200

Resposta bem sucedida. Inspecione o estado retornado para operações que iniciam trabalho assíncrono.

Um esquema completo de corpo-resposta não é publicado para esta operação personalizada. Inspecione o conteúdo e o status retornados; nenhuma carga útil é assumida aqui.

Convide um membro da equipe

POST /v1/team/invitations

Envie um convite por e-mail para entrar na equipe selecionada. role aceita user, manager ou team_admin.

Esta requisição altera dados ou inicia uma ação. Confira o destino e o corpo antes de enviá-la.

Autenticação: token bearer e o cabeçalho de equipe mostrado abaixo.

Parâmetros

Nome	Localização	Obrigatório	Descrição
`X-Tenant-ID`	cabeçalho	sim	ID da equipe ativa. Deve corresponder ao tenant vinculado a um token de diagnóstico.

Exemplo de requisição

curl --fail-with-body --request POST "$ADIOS_API_URL/v1/team/invitations" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID" \
  -H "Content-Type: application/json" \
  --data-binary @- <<'JSON'
{
  "email": "YOUR_INVITE_EMAIL",
  "role": "user"
}
JSON

Substitua YOUR_* no corpo antes de enviar. O heredoc com delimitador entre aspas mantém o JSON literal.

Resposta: HTTP 200

Resposta bem sucedida. Inspecione o estado retornado para operações que iniciam trabalho assíncrono.

Um esquema completo de corpo-resposta não é publicado para esta operação personalizada. Inspecione o conteúdo e o status retornados; nenhuma carga útil é assumida aqui.

Reenviar convite da equipe

POST /v1/team/invitations/{id}/resend

Envie o e-mail do convite novamente.

Defina invitation_id usando IDs das suas próprias respostas da API.

Esta requisição altera dados ou inicia uma ação. Confira o destino e o corpo antes de enviá-la.

Autenticação: token bearer e o cabeçalho de equipe mostrado abaixo.

Parâmetros

Nome	Localização	Obrigatório	Descrição
`id`	caminho	sim	Identificador de recurso dos resultados da API da sua equipe.
`X-Tenant-ID`	cabeçalho	sim	ID da equipe ativa. Deve corresponder ao tenant vinculado a um token de diagnóstico.

Exemplo de requisição

curl --fail-with-body --request POST "$ADIOS_API_URL/v1/team/invitations/${ADIOS_INVITATION_ID}/resend" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Resposta: HTTP 200

Resposta bem sucedida. Inspecione o estado retornado para operações que iniciam trabalho assíncrono.

Um esquema completo de corpo-resposta não é publicado para esta operação personalizada. Inspecione o conteúdo e o status retornados; nenhuma carga útil é assumida aqui.

Revogar convite da equipe

DELETE /v1/team/invitations/{id}

Revogar um convite pendente.

Defina invitation_id usando IDs das suas próprias respostas da API.

Esta requisição altera dados ou inicia uma ação. Confira o destino e o corpo antes de enviá-la.

Autenticação: token bearer e o cabeçalho de equipe mostrado abaixo.

Parâmetros

Nome	Localização	Obrigatório	Descrição
`id`	caminho	sim	Identificador de recurso dos resultados da API da sua equipe.
`X-Tenant-ID`	cabeçalho	sim	ID da equipe ativa. Deve corresponder ao tenant vinculado a um token de diagnóstico.

Exemplo de requisição

curl --fail-with-body --request DELETE "$ADIOS_API_URL/v1/team/invitations/${ADIOS_INVITATION_ID}" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Resposta: HTTP 200

Resposta bem sucedida. Inspecione o estado retornado para operações que iniciam trabalho assíncrono.

Um esquema completo de corpo-resposta não é publicado para esta operação personalizada. Inspecione o conteúdo e o status retornados; nenhuma carga útil é assumida aqui.