---
title: "Reverse lookup to return list of user_ids based on e-mails or phones"
method: POST
path: "/users/reverse-lookup"
tags: ["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

- GetUserIdsByReverseLookup
  - `type` 'email' | 'phone' | 'carbon_link' | 'name', required: Whether to lookup by email or phone (only one type is allowed)
  - `emails` string[]: List of emails
  - `phones` string[]: List of phones
  - `names` string[]: List of Carbon Link names

## Response `200`

- GetUserIdsByReverseLookupResponse
  - `type` 'email' | 'phone' | 'carbon_link' | 'name', required: Informed type to lookup for (email or phone)
  - `total_lookup_count` number, required: Total items informed to do reverse-lookup
  - `total_found_count` number, required: Total items found for the reverse-lookup
  - `reverse_lookup` object[], required: Map of email or phone to user_id

## Other responses

- `403`

---

[API](https://skmtc.dev/carbonvoice/apis/carbon-voice-api.md) · [All operations](https://skmtc.dev/carbonvoice/apis/carbon-voice-api/llms.txt) · [OpenAPI document](https://skmtc.dev/carbonvoice/apis/carbon-voice-api/revisions/b91c5c845122?raw)