Get the inbox status
Whether receiving email is set up (configured), the inboxes the key's creator can see with their addresses and open conversations, and the counts behind…
https://app.usenotix.dev/api/v1/inbound/statusFull access and read only keys can call this. Sending access keys cannot. Key permissions lists the extra rules some calls have.
Whether receiving email is set up (configured), the inboxes the key's creator can see with their addresses and open conversations, and the counts behind the inbox's tabs, with how many conversations are unread for that person.
Who can call it
Any key that may read received mail: full access and read only. A send-only key and a live AI key answer 403 SCOPE_DENIED.
Whose inbox
The key acts as the person who created it, as they are on the team today: a team admin sees every inbox, a member only the inboxes they belong to. Read marks are that person's, and notes, assignments and replies carry their name. A key whose creator left the team, or made before Notix recorded who made each key, answers 403 FORBIDDEN. A key limited to one domain sees only the inboxes that receive mail on that domain. The thread does not say a change came through the API: it carries the creator's name, and the key's audit log (GET /v1/audit-log) records which key made it.
The team can make 120 inbox reads a minute through the API; when Notix cannot count them the answer is 503 SERVICE_UNAVAILABLE (try again shortly), never a 429.
Headers
Bearer followed by your API key.
Errors
`SCOPE_DENIED`: a send-only or live AI key. `FORBIDDEN`: the key's creator has left the team, or the key is older than Notix's record of who made each key.
The read took longer than 30 seconds.
The team read the inbox 120 times in the last minute.
The inbox's rate counters cannot be read just now; try again shortly.
Every error has the same shape. See all error codes.
curl -X GET "https://app.usenotix.dev/api/v1/inbound/status" \
-H "Authorization: Bearer $NOTIX_API_KEY"
import { Notix } from "notix-js";
const notix = new Notix(process.env.NOTIX_API_KEY);
const { data, error } = await notix.conversations.status();
{
"configured": true,
"inboxes": [
{
"id": "cm1x8f3k20001qz7v5b9d2e4a",
"name": "Acme",
"addresses": [
null
],
"openCount": 1
}
],
"counts": {
"views": {
"mine": 1,
"unassigned": 1,
"open": 1,
"pending": 1,
"closed": 1,
"spam": 1
},
"unread": 1
}
}