Seats
Seat
GET
Bearerheader
AuthorizationBearer <JWT>uid*stringseat uid
Format
uuidThe seat
application/json- response
success*trueValue in
truedata*Example Request
curl -X GET 'http://localhost:3000/seats/497f6eca-6276-4993-bfeb-53cbbbba6f08'Example Response
{ "success": true, "data": { "uid": "string", "status": "pending", "price": { "uid": "string", "amountCents": 0, "currency": "string", "interval": "month", "campaignCode": "string" }, "dependent": { "kind": "minor", "name": "string", "birthDate": "2019-08-24", "relationship": "child", "phone": "string", "document": { "type": "cpf", "number": "string" } }, "attested": true, "consent": { "status": "pending", "requestedAt": "2019-08-24T14:15:22Z", "givenAt": "2019-08-24T14:15:22Z", "expiresAt": "2019-08-24T14:15:22Z", "sentAt": "2019-08-24T14:15:22Z", "deliveredAt": "2019-08-24T14:15:22Z", "openedAt": "2019-08-24T14:15:22Z", "declinedAt": "2019-08-24T14:15:22Z", "resendAvailableAt": "2019-08-24T14:15:22Z", "revokedAt": "2019-08-24T14:15:22Z", "revokedBy": "guardian", "deliveryChannel": "whatsapp", "link": "string", "needsRenewal": true }, "backgroundCheck": { "status": "pending" }, "pause": { "cause": "guardian", "since": "2019-08-24T14:15:22Z", "until": "2019-08-24T14:15:22Z", "byName": "string", "reason": "string" }, "activatedAt": "2019-08-24T14:15:22Z", "activationRequiresConsent": true, "trial": { "state": "not_started", "startsOn": "first_connection", "days": 0, "startedAt": "2019-08-24T14:15:22Z", "endsAt": "2019-08-24T14:15:22Z", "label": "string" }, "createdAt": "2019-08-24T14:15:22Z" }}Resend a family invite POST
Owner only. Mails the invite again, in the resending owner's name, and gives it a fresh 7 days — the way back from `expired`. A member who already joined has no invite (422 INVITE_ALREADY_ACCEPTED). At most RATE_INVITE_RESEND_PER_MEMBER per member (default 3 an hour).
Remove a seat DELETE
Archives a pending (or paused) seat added by mistake; it leaves the account's lists. Active seats are refused (422 SEAT_ACTIVE). Owner only. Idempotent.