v1

latestOpenAPI 3.1.02026-07-24174964.1 KB

Invites

Obter Dados de um Invite

Retorna dados do cliente e do invite (status, jornada, tentativas, datas).

get/api/v1/account/invite/{invite_id}

Path parameters

invite_idstring required

Id do invite

Response

Dados do invite e do cliente

Example response

{
  "customer": {
    "attributes": [
      {
        "label": "Telefone",
        "value": "(11) 98765-4321"
      }
    ],
    "cpf": "12345678901",
    "fullName": "Maria Silva Santos",
    "name": "Maria"
  },
  "invite": {
    "attempts": 1,
    "createdAt": "2025-03-20T14:30:00Z",
    "customerJourneyStatus": "agreement",
    "customerJourneyType": "agreement",
    "expiresAt": "2025-04-20T23:59:59Z",
    "status": "pending"
  }
}