contacts

Search

The caller's own address book. contact_type is linked (points at a real platform account) or custom (off-platform, owner-entered details). favorite=true returns only favorited contacts; favorites always sort first regardless of the sort param. Rows are overlaid (best-effort) with each linked contact's unacked-fulfillment badge from enforcer-cybrid — a badge omission means the overlay call failed or is disabled, not that the count is zero.

get/contacts

Request

  • Base URL: https://api.instruxi.dev/api/v1/enforcer
  • URL: https://api.instruxi.dev/api/v1/enforcer/contacts
  • Auth: one of:
    • API key in header Authorization
    • API key in header X-API-Key

Query parameters

qstring

search query

contact_typestring

contact_type

activeboolean

active

blacklistedboolean

blacklisted

favoriteboolean

when true, only favorited contacts (favorite_rank set)

sort'name' | 'display_name' | 'name_desc' | 'display_name_desc' | 'recent' | 'oldest'

name / display_name (A-Z, default) | name_desc / display_name_desc | recent | oldest. Favorites always sort first; id breaks ties; an unknown value falls back to name.

limitinteger

limit

offsetinteger

offset

Response

OK

limitinteger
offsetinteger
successboolean
totalinteger

Example response

{
  "success": true
}

Changes

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