Skip to content
Optiwork API Docs

Unread count for a folder

GET
/mail/mailboxes/{mailbox}/folders/{folderId}/conversations/unread/count
curl --request GET \
  --url 'https://mail.work.optidata.cloud/api/mail/mailboxes/78/folders/2/conversations/unread/count?filter=all' \
  --header 'Authorization: Bearer <token>'

How many unread messages the folder holds — the number a sidebar badge shows. Passing filter=read always answers 0, by definition.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
mailbox
required
integer

Id of the mailbox. Every mailbox the caller may use is listed in their account.

folderId
required
string

Id of the folder, as returned by GET /folders.

Query Parameters

Section titled “Query Parameters”
filter

The listing filters. all shows everything, read and unread filter by state, from_company keeps mail sent from inside the company, with_calendar_invite keeps mail carrying an invitation, and snoozed keeps hidden threads.

string
Allowed values: all read unread from_company with_calendar_invite snoozed

Narrow the listing. all is the default; read and unread filter by state, from_company keeps mail sent from inside the company, and with_calendar_invite keeps mail carrying a calendar invitation. Ignored in folders whose shouldDisplayFilterTab is false.

Responses

Section titled “ Responses ”

200

Section titled “200”

The unread count.

Media typeapplication/json
object
total
required
integer
Examples
Examplecount
{
  "total": 3
}

401

Section titled “401”

Missing, malformed or expired authentication key.

Media typeapplication/json

Authentication failures use an error key rather than message.

object
error
required
string
Examples
Examplemissing

No bearer token sent

{
  "error": "JWT passport exception: Missing bearer token in request"
}

403

Section titled “403”

The caller may not act on this mailbox, user or resource.

Media typeapplication/json

Generic error envelope used by policy, binding and framework failures.

object
message
required

Human-readable description of the failure.

string
Examples
Exampledenied
{
  "message": "This action is unauthorized."
}

422

Section titled “422”

The request body or query string failed validation.

Media typeapplication/json
object
message
required

The first validation message.

string
errors
required

Validation messages keyed by field name.

object
key
additional properties
Array<string>
Examples
Exampleinvalid
{
  "message": "The conversations field is required.",
  "errors": {
    "conversation_ids": [
      "The conversations field is required."
    ]
  }
}

429

Section titled “429”

Rate limit exceeded. Retry after the window resets.

Media typeapplication/json

Generic error envelope used by policy, binding and framework failures.

object
message
required

Human-readable description of the failure.

string
Examples
Examplethrottled
{
  "message": "Too Many Attempts."
}

502

Section titled “502”

The mail platform did not answer as expected — a folder or message that does not exist, or a transient failure. reference is the code to quote to support and fault_code names the underlying condition. A 503 with the same envelope means the platform is in maintenance; retry shortly.

Media typeapplication/json

Failure raised by the mail platform behind the API rather than by the request itself.

object
error
required

What went wrong, phrased for the end user.

string
status
required

Repeats the HTTP status code.

integer
help
required

Suggested next step.

string
reference
required

Support reference, e.g. MZ-502.

string
fault_code

Names the underlying condition, e.g. mail.NO_SUCH_FOLDER.

string | null
Examples

Unknown folder

{
  "error": "The mail server did not answer as expected, so this action could not be completed.",
  "status": 502,
  "help": "If the problem persists, contact support and inform the error code above.",
  "reference": "MZ-502",
  "fault_code": "mail.NO_SUCH_FOLDER"
}