Pular para o conteúdo
BetaDocumentação em validação contínua. Comportamento descrito pode divergir do servidor — abra um chamado no app se algo não bater.
/notes

Notes

Notas em formato livre (markdown) vinculadas a pessoas, empresas ou deals. Use pra capturar contexto qualitativo — resumo de call, decisão de stakeholder, próximos passos.

  • Conteúdo aceita markdown completo (links, listas, citações, code).
  • Pinned notes ficam no topo da timeline do objeto pai.
  • v1 atual expõe apenas GET (list/by-id) e POST. Edição/exclusão acontece pelo app web.
  • Webhook: note.created.

Endpoints

Clique em qualquer linha pra ir direto à reference detalhada.

Reference

GET/notes

Listar notas

Query parameters

pageinteger
Número da página (1-indexado).
pageSizeinteger
Itens por página. Máximo 100.

Responses

  • 200OK.

Resposta 200

pageintegerrequired
pageSizeintegerrequired
totalintegerrequired
hasMorebooleanrequired
dataarray<Note>required
curl https://api.usemix.app/api/v1/notes \
  -H "Authorization: Bearer manu_seu_token_aqui"
GET/notes/{id}

Buscar nota

Path parameters

idstring<uuid>required
Identificador único do recurso.

Responses

  • 200OK.

Resposta 200

idstring<uuid>required
tenantIdstring<uuid>required
contentstringrequired
Markdown suportado.
objectTypeenum<"person" | "company" | "deal">required
personcompanydeal
objectIdstring<uuid>required
authorIdstring<uuid>
pinnedboolean
createdAtstring<date-time>required
updatedAtstring<date-time>
curl https://api.usemix.app/api/v1/notes/<id> \
  -H "Authorization: Bearer manu_seu_token_aqui"
POST/notes

Criar nota

Vincula a nota a um objeto (person/company/deal). Conteúdo aceita markdown. A v1 atual não expõe PATCH/DELETE em notas.

Request body

contentstringrequired
objectTypeenum<"person" | "company" | "deal">required
personcompanydeal
objectIdstring<uuid>required
pinnedboolean

Responses

  • 201Criada.

Resposta 201

idstring<uuid>required
tenantIdstring<uuid>required
contentstringrequired
Markdown suportado.
objectTypeenum<"person" | "company" | "deal">required
personcompanydeal
objectIdstring<uuid>required
authorIdstring<uuid>
pinnedboolean
createdAtstring<date-time>required
updatedAtstring<date-time>
curl -X POST https://api.usemix.app/api/v1/notes \
  -H "Authorization: Bearer manu_seu_token_aqui" \
  -H "Content-Type: application/json" \
  -d '{
  "content": "string",
  "objectType": "person",
  "objectId": "00000000-0000-0000-0000-000000000000",
  "pinned": false
}'

Relacionados

A gente usa cookies pra entender o que funciona e o que não funciona aqui. Sem terceiros — dado fica conosco. Política.