Skip to main content

List / filter contacts

GET 
/contacts

filter[phone] is the screen-pop lookup: it compares the last 9 digits of the digits-only form on both sides, so an E.164 query matches a contact however the number was typed in (+977 984 123 4567, 984-123-4567, 9841234567).

Two things to build around:

  • It is a SUFFIX match — two numbers in different countries sharing their last nine digits collide. Check the full stored number before attaching anything irreversible.
  • meta.total_count > 1 means the number is ambiguous (a shared office line).
  • A query under 5 digits is ignored — the filter is dropped and the full list comes back, not an empty result. Do not read that as a match.

Scope: read:contacts (implied by write:contacts).

Request​

Responses​

A page of resources. meta carries the pagination counters.