GET
/
rest
/
users
Get All Users
curl --request GET \
  --url https://api.exchange.fairx.net/rest/users
[
  {
    "user_uuid": "123e4567-e89b-12d3-a456-426614174000",
    "name": "John Doe",
    "user_role": "FIX_USER",
    "sender_comp_id": "TRADER001",
    "firm_uuid": "abcdef12-3456-7890-abcd-ef1234567890",
    "itm_uuid": "98765432-dcba-4321-9876-543210fedcba",
    "cancel_on_disconnect": true,
    "client_requested_trading_lock": false,
    "admin_trading_lock": false,
    "self_match_prevention_id": 123,
    "self_match_prevention_mode": "CANCEL_AGGRESSING"
  }
]

Query Parameters

​
firm_uuid
string

The UUID of the desired users' parent firm.

Example:

"abcdef12-3456-7890-abcd-ef1234567890"

Response

200
application/json

Successfully retrieved users

The response is of type object[].