---
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, will be included in uid
    - `uid` string — id of a matching user
    - `display_name` string — Display name of a matching user
    - `displayName` string — Display name of a matching user
    - `givenName` string — Display name of a matching user
    - `givenname` string — Display name of a matching user
    - `cn` string — Display name of a matching user
    - `avatar_url` string — Avatar URI of a matching user following the mxc format https://spec.matrix.org/v1.10/client-server-api/#matrix-content-mxc-uris
    - `last_name` string — Last name of a matching user
    - `first_name` string — First name of a matching user
    - `mail` string — Email address of a matching user
    - `emails` string[]
    - `mobile` string — Mobile phone number of a matching user
    - `phones` string[]
    - `language` string — Language of a matching user
    - `timezone` string — Timezone of a matching user

## Other responses

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

---

[API](https://skmtc.net/linagora/apis/twake-on-matrix-apis-documentation.md) · [All operations](https://skmtc.net/linagora/apis/twake-on-matrix-apis-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/linagora/twake-on-matrix-apis-documentation/revisions/3428c7bb5a46/schema)