Skip to main content
O card é a unidade de trabalho, e a única coisa nesta API que é dona de uma branch. O número dele é contado por quadro.

Um card

endpoint
integer
obrigatório
O número do card, como o quadro o mostra. Contado por quadro — #7 existe em todo quadro, e você recebe o do quadro que você nomeou.
O array repositories é a parte que mais ninguém tem: a branch de que este card é dono em cada repositório, o pull request que ele abriu, e o que o provedor diz sobre os checks. É essa a junção entre um quadro e um repositório, e é por isso que dá para perguntar a um card se ele consegue se mover antes de alguém arrastá-lo.
object | null
Presente quando a última promoção foi recusada, com o motivo nas palavras do próprio provedor — conflitos, checks vermelhos, nada para fazer merge. null quando o card está livre para se mover.
string | null
O que o CI disse, por repositório: passing, failing, pending, ou null quando nada reportou. Isso rodou no provedor, não aqui.

A história

endpoint
Tudo que aconteceu com o card, com a discussão entremeada — comentários, movimentos, branches cortadas, pushes, pull requests, o que os agentes fizeram. Mais antigo primeiro. O app mostra do mais novo para o mais velho porque o motivo de alguém abrir um card é o que acabou de acontecer; a API manda na ordem em que foi registrado, que é a ordem que qualquer um construindo o próprio log quer.
Todo item tem um type de event ou comment e um at. Leia kind para decidir o que foi um evento — ele é minúsculo com underscores (created, status_changed, branch_created, pushed) — e trate um que você não conhece como algo a pular, não como algo em que falhar: novos são adicionados. actor.user.kind diz o que fez aquilo. Um machine é uma credencial da API, um agent é um agente, e login carrega um nome de usuário do provedor para os eventos que o provedor nos contou, e não para os que aconteceram aqui.

Criar um card

endpoint
string
obrigatório
De 1 a 500 caracteres.
string
Markdown, até 20.000 caracteres.
string
Qual produto. Obrigatório quando o quadro tem vários.
string
Onde ele começa. Omitido, ele cai no backlog como rascunho, que é o que normalmente se quer — iniciá-lo é o ato que corta uma branch.
boolean
Cortado da ponta final do fluxo em vez da inicial. Perguntado na criação porque é aí que alguém sabe, e porque a resposta precisa estar dada antes de um repositório ser ligado.
createdBy.kind é machine, e é esse o sentido de uma credencial de escrita ser membro: o quadro consegue dizer que um script fez isso, em vez de dar a entender que foi um colega.

Alterar um

endpoint
Só o que você nomeia muda. Campos omitidos ficam como estão; null em assignee, dueDate, parentNumber ou featureId limpa cada um, o que é diferente de não tocar neles.
string
string
string
none, low, medium, high ou urgent.
string | null
Precisa ser membro deste quadro.
string[]
O conjunto inteiro, não um delta.
string | null
Responde com o card inteiro.

Mover um

endpoint
A escrita que executa Git. Ela corta uma branch, abre um pull request ou faz merge de um, dependendo de onde o card cai — veja Escrever para as recusas e o que 409 quer dizer aqui.
string
obrigatório
O estágio para onde mover. Vem de /v1/board, onde cada coluna carrega o próprio id e o minRole necessário para entrar nela.
integer
obrigatório
Posição na coluna de destino. 0 é o topo.
promoted é vazio quando nada fez merge — um card sem repositório ligado, ou um estágio cuja regra de fluxo não toca nenhum. Não é uma falha; é a resposta honesta de que o quadro se moveu e o Git não tinha o que fazer.

Comentar

endpoint
string
obrigatório
De 1 a 10.000 caracteres, markdown.
Um comentário num card cujo pull request está aberto é espelhado no provedor, e mirroredTo diz a quantos ele chegou. A discussão é uma conversa só, esteja a pessoa onde estiver.

Apagar um

endpoint
204, e nada no corpo.