API Reference

Get contact details

get
https://example.com/api/ext/v3/contacts/
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
📘

BSUID Support: The target path/body parameter now supports additional identifier formats:

FormatExampleDescription
Phone Number14155552671Contact by phone (existing)
Contact ID507f1f77bcf86cd799439011Contact by MongoDB ID (existing)
BSUIDUS.123124141512Contact by Business Solution User ID (new)
Channel:PhoneMyChannel:14155552671Contact scoped to channel (existing)
Channel:ContactIdMyChannel:507f...Contact + channel (existing)
Channel:BSUIDMyChannel:US.123124141512Contact by BSUID + channel (new)

The system auto-detects the format. Existing callers using phone numbers or Contact IDs continue to work.

Path Params
string
required

The target contact in the following formats:

  • ContactId: The unique ID of a contact.
  • PhoneNumber: The contact's phone number (e.g., 14155552671).
  • Channel:PhoneNumber: A combination of the channel (name or phone number) and the recipient's phone number (e.g., MyChannel:1415552671, 123456789:1415552671).
Responses

401

The request is unauthorized.

429

Too many requests. Either the rate limit has been exceeded or usage limits have been reached.

Updated 2 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago