Retrieve a thread
The thread’s subject, folder, labels and read state; its emails are listed apart.
GET
/inboxes/{inbox_id}/threads/{thread_id}Autorização
AuthorizationToken Bearer · headerobrigatórioA BillionSend API key (bs_…).
Parâmetros de caminho
inbox_idstringobrigatórioThe inbox ID or its email address, such as support@example.com
thread_idstring<uuid>obrigatórioThe thread ID
Respostas
200
Thread
objectstringobrigatórioValores permitidos:
inbox_threadidstring<uuid>obrigatóriosubjectstring | nullobrigatóriofolderstringobrigatórioValores permitidos:
inboxarchivespamsenttrashlabelsobject[]obrigatórioMostrar propriedadesOcultar propriedades
Array de
objectidstring<uuid>obrigatórionamestringobrigatóriocolorstringobrigatórioreadbooleanobrigatórioquarantinedintegerobrigatórioBillionSend extension: held messages; 0 for inbox-scoped keys
401
Missing, malformed, unknown or revoked API key
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatório404
Not found
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatório429
Over the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatório