Parameters

NameTypeRequiredDescription
brandIdstringYesOcoya brand id from ocoya_list_brands.
querystringNoSearch by email address or name.
statusstringNoOnly contacts with this status. One of subscribed, unsubscribed, bounced, complained.
groupIdstringNoOnly contacts in this group.
pagenumberNoZero-based page number. Defaults to 0.
perPagenumberNoItems per page, up to 100. Defaults to 25.

Request example

{
  "name": "ocoya_list_contacts",
  "arguments": {
    "brandId": "cmayvq3hk00017apshay5qezu",
    "query": "launch"
  }
}

Returns

Returns the result of the call as JSON. This tool only reads: it changes nothing in Ocoya.