User

Reverse lookup to return list of user_ids based on e-mails or phones

post/users/reverse-lookup

Request

  • Base URL: https://api.carbonvoice.app
  • URL: https://api.carbonvoice.app/users/reverse-lookup
  • Auth: one of:
    • API key in header pxtoken
    • OAuth 2 (implicit, authorization URL https://api.carbonvoice.app/oauth/authorize)

Request body

type'email' | 'phone' | 'carbon_link' | 'name' required

Whether to lookup by email or phone (only one type is allowed)

emailsstring[]

List of emails

phonesstring[]

List of phones

namesstring[]

List of Carbon Link names

Response

type'email' | 'phone' | 'carbon_link' | 'name' required

Informed type to lookup for (email or phone)

total_lookup_countnumber required

Total items informed to do reverse-lookup

total_found_countnumber required

Total items found for the reverse-lookup

reverse_lookupobject[] required

Map of email or phone to user_id

Example response

{
  "reverse_lookup": [
    {
      "john.doe@phononx.com": "5f9b3b4b9c6d2c0012c9e3d0"
    },
    {
      "jane@phononx.com": "5HAlOHVi7U3gu50Z"
    }
  ]
}

Changes

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