---
title: "POST /_twake/identity/v1/lookup/match"
method: POST
path: "/_twake/identity/v1/lookup/match"
tags: ["Identity server"]
---

# POST /_twake/identity/v1/lookup/match

`POST /_twake/identity/v1/lookup/match`

Looks up the Organization User IDs which match value sent

## Request body

- object
  - `scope` string[], required
  - `fields` string[], required
  - `val` string — Optional value to search
  - `limit` integer — Optional max number of result to return (default 30)
  - `offset` integer — Optional offset for pagination

## Response `200`

Success

- object
  - `matches` object[] — List of users that match
    - `address` string — Matrix address
    - `uid` string — id of a matching user
    - `mail` string — email address of a matching user

## Other responses

- `400` — Bad request
- `401` — Unauthorized

## Changes

- **2024-01-09** `c7a6d3a400a7` — 13 warning, 4 info
  - removed the optional property `matches/items/avatar_url` from the response with the `200` status
  - removed the optional property `matches/items/cn` from the response with the `200` status
  - removed the optional property `matches/items/displayName` from the response with the `200` status
  - removed the optional property `matches/items/display_name` from the response with the `200` status
  - …13 more

[Change history](https://skmtc.dev/linagora/apis/twake-on-matrix-apis-documentation/changes/_twake/identity/v1/lookup/match/post.md)

---

[API](https://skmtc.dev/linagora/apis/twake-on-matrix-apis-documentation.md) · [All operations](https://skmtc.dev/linagora/apis/twake-on-matrix-apis-documentation/llms.txt) · [OpenAPI document](https://skmtc.dev/linagora/apis/twake-on-matrix-apis-documentation/revisions/ecce38b281bc?raw)