Search mailbox

This document contains details for the GET /api/v1/mailbox/search endpoint, including headers, the q query parameter, request and response examples, and status codes.

Use this endpoint to find mailboxes and contacts before you assign recipients in an envelope flow. Search the current mailbox context by UUID, alias, mailbox name, or contact name.

Endpoint
Method	GET
Request URL	/api/v1/mailbox/search
Headers
Authorization *	Bearer {token}
Content-Type	application/json
mailboxUuid *	Current mailbox UUID
Request
q *	Search string

Use q to search by:

• mailbox UUID

• mailbox alias

• mailbox name

• contact name

Request example

GET /api/v1/mailbox/search?q=[e-mail]
Authorization: Bearer {token}
Content-Type: application/json
mailboxUuid: 837bc65e-4818-48f5-a933-2d00b24b6e12

Response example

This example shows the general response shape.

{
  "data": [
    {
      "uuid": "9baec31c-e940-4894-b6d1-52033e1af66e",
      "alias": "john-doe",
      "name": "John Doe",
      "email": "[e-mail]"
    },
    {
      "uuid": "42c95245-30c1-46ef-bd5b-a9a111deec10",
      "alias": "legal-team",
      "name": "Legal Team",
      "email": "[e-mail]"
    }
  ],
  "numberOfElements": 2,
  "sizeRequested": 2,
  "totalElements": 2
}

Use Swagger UI for the exact response schema.

Response status codes

Code	Description
200	Success
401	Not authorized
403	Forbidden

Related topics

• Send Envelope

• Envelope Forms

• Check Envelope Status