Marketing (experimental)

List contacts

EXPERIMENTAL — enabled account by account; without it every call answers 403 module_disabled. Scopes read:contacts / write:contacts. Oldest first (by id), with an opaque cursor. Deleted contacts are not listed.

get/contacts

Request

  • Base URL: https://api.oveyon.com/v1
  • URL: https://api.oveyon.com/v1/contacts
  • Auth: HTTP bearer

Query parameters

qstring

Prefix of the email (case-insensitive).

listIdinteger
status'pending' | 'subscribed' | 'unsubscribed'

Only with listId.

tagIdinteger
limitinteger
cursorstring

The next_cursor of the previous page. Cursors from different routes are not interchangeable (400 bad_cursor).

Response

Page

next_cursorstring nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.