BEbetagouv
contacts

GET /api/v1.0/contacts/

Changed on

List contacts with optional filtering by mailbox and search query. For a mailbox, it returns all contacts in the mailbox and all contacts in the same domain as the mailbox.

Query parameters:

  • mailbox_id: Optional UUID to filter contacts by mailbox
  • q: Optional search query for name or email (case insensitive)

Request

  • The document declares no server URL.
  • Auth
    API key in cookie sessionid

Query parameters

mailbox_idstring uuid

Filter contacts by mailbox ID.

qstring

Search contacts by name or email (case insensitive).

Response

idstring uuid required

primary key for the record as UUID

namestring nullable
emailstring required

Changes