Search Contacts

Tool name: search-contacts

Returns a cursor-paginated list of contact channels in one KlickTipp account, sorted by address. One row is one channel: a contact reachable by email and by SMS appears twice, each time with that channel's own address and subscription status, and channel says which it is. The lean results carry the contact ID, address, status and edit link, and intentionally omit contact fields and reference data. query takes an email fragment or a mobile number written with its country code (+49... or 0049...); a number in a form the account cannot read is refused by name rather than answered with nothing. Filter further by status, channel or a writable manual tag. The returned nextCursor, unchanged and with the same filters, is the next page. One contact in full is get-contact.

Input schema

querynull or string, <= 250 characters

Case-insensitive fragment of an email address, or a mobile number with its country code; omit to match every contact

Default:null

statusnull or string

Subscription status to filter by; omit for every status

Default:null

Enum:"pending""optin""subscribed""unsubscribed"

manualTagIdnull or integer, >= 1

ID of an existing manual tag the returned contacts must have

Default:null

channelnull or string

Restrict to one channel, email or sms; omit for both

Default:null

Enum:"email""sms"

cursornull or string, <= 500 characters

Opaque nextCursor value of the previous result page; omit for the first page

Default:null

pageSizeinteger, [ 1 .. 100 ]

Maximum contacts on the page, from 1 through 100

Default:25

accountIdnull or integer, >= 1

User ID of the account; omit for the account the access token works in

Default:null

Input example

{
  "query": null,
  "status": "pending",
  "manualTagId": null,
  "channel": "email",
  "cursor": null,
  "pageSize": 25,
  "accountId": null
}

Output schema

accountIdintegerrequired

pageSizeintegerrequired

countintegerrequired

hasMorebooleanrequired

nextCursorstring or nullrequired

contactsArray of objectsrequired

Output example

{
  "accountId": 0,
  "pageSize": 0,
  "count": 0,
  "hasMore": true,
  "nextCursor": "string",
  "contacts": [
    {
      "contactId": 0,
      "channel": "email",
      "contactInfo": "string",
      "email": "string",
      "subscriptionStatus": "string",
      "editUrl": "string"
    }
  ]
}