POST/users/search

User Search

Search for a specific user by username or user ID. Provide the target in To and the source user in From.

Headers

Field	Type	Required	Possible values	Description
`session-token`	string	Required	—	SessionToken obtained from the Create GMA Session endpoint. All secured endpoints require this header.

Request body

Field	Type	Required	Possible values	Description
`To`	string	Required	—	Username, Email, or Account number to search for.
`From`	string	Optional	—	Source user ID initiating the search.

Example request

{
  "To": "john.doe",
  "From": "-6824187852572151984"
}

{
  "To": "john.doe",
  "From": "-6824187852572151984"
}

Response

Field	Type	Possible values	Description
`ResponseCode`	integer	200 \| 201 \| 204 \| 301 \| 400 \| 401 \| 403 \| 404 \| 410 \| 422 \| 500 \| 503	API result code in the response envelope. Indicates success or the error category (e.g. 200 success, 400 bad request, 401 unauthorized).
`ResponseMessage`	string	Success \| Created \| NoContent \| BadRequest \| Unauthorized \| Forbidden \| NotFound \| Gone \| UnprocessableContent \| ServerError \| ResourceMoved \| ServiceUnAvailable \| UnProcessableEntity	Human-readable label paired with ResponseCode (e.g. Success, BadRequest, Unauthorized). Use with ResponseCode to interpret the outcome.
`ResponseData`	object	Please refer to below example for response body	User details matching the search query.

Example response

{
  "ResponseCode": 200,
  "ResponseMessage": "Success",
  "ResponseData": {
    "Name": "John Doe",
    "Username": "john.doe",
    "Email": "john.doe@example.com",
    "AccountNumber": "****0001",
    "Role": "USER",
    "FinancialTransactionEnabled": true
  }
}

{
  "ResponseCode": 200,
  "ResponseMessage": "Success",
  "ResponseData": {
    "Name": "John Doe",
    "Username": "john.doe",
    "Email": "john.doe@example.com",
    "AccountNumber": "****0001",
    "Role": "USER",
    "FinancialTransactionEnabled": true
  }
}

Requires `session-token: {SessionToken}` from Create GMA Session. Use the same client IP as authentication.