Users

List the users (agents) in your workspace, with filtering by role and status, including their custom user fields.

Users

List the users in your workspace. This endpoint returns workspace members along with their email, display name and custom user fields. Use it to map MeetRox users to records in external systems, or to look up user_id values to use when importing calls.

📘

Custom user fields require activation

Custom user fields are enabled per workspace. To use them, ask the MeetRox team to activate the feature in your environment. Until it is activated, the custom_fields attribute is not included in the response. See Custom Fields below.


List Users

GET /v1/users

Returns a paginated list of workspace users.

Query Parameters

Filtering

ParameterTypeValuesDescription
statusstringactive, inactiveFilter by blocking status. active returns users who are not blocked; inactive returns blocked users. Omit to return all.
rolestringadmin, manager, member, guestFilter by workspace role. Omit to return all roles.

Pagination

Cursor-based pagination:

ParameterTypeDescription
firstintegerNumber of records to return
afterstringCursor from the previous response's end_cursor
lastintegerNumber of records from the end
beforestringCursor from the previous response's start_cursor

Example

# List all active members
curl "https://api.meetrox.ai/v1/users?status=active&role=member" \
  -H "x-api-key: YOUR_API_KEY"

Response

{
  "data": [
    {
      "user_id": 15,
      "workspace_id": 7,
      "email": "[email protected]",
      "name": "Ana Silva",
      "custom_fields": {
        "admission_date": "2026-01-15",
        "department": "sales",
        "employee_code": 884412,
        "country": "Brasil"
      }
    },
    {
      "user_id": 22,
      "workspace_id": 7,
      "email": "[email protected]",
      "name": "Carlos Rocha",
      "custom_fields": {}
    }
  ],
  "meta": {
    "page_size": 50,
    "has_next_page": false,
    "has_previous_page": false,
    "start_cursor": null,
    "end_cursor": null,
    "errors": [],
    "params": {}
  }
}

Response Fields

FieldTypeDescription
user_idintegerThe user's unique ID in MeetRox
workspace_idintegerThe workspace this user belongs to
emailstringThe user's email address
namestringThe user's display name
custom_fieldsobjectThe user's custom field values, keyed by field key. Only present when custom user fields are enabled for the workspace. See below.

Custom Fields

Custom user fields let your workspace attach organization-specific data to each member, such as admission date, department, country or an internal employee code. Managers define the fields in MeetRox under Manage > Team > Custom fields and fill in the values per user.

The custom_fields object maps each field key to the user's value for that field:

  • Keys are defined by the workspace manager when the field is created. They contain only lowercase letters, numbers and underscores (for example, admission_date), and never change after creation, so they are safe to use as stable identifiers in your integration.
  • Only fields with a value are included. A field the user has no value for is omitted from the object. A user with no values at all returns an empty object ({}).
  • Deleted fields disappear. When a manager deletes a field in MeetRox, its key is removed from every user.

The value format depends on the field type:

Field typeJSON typeFormatExample
TextstringFree text, up to 1000 characters"Brasil"
NumbernumberInteger, or decimal when the value has a fractional part884412
DatestringISO 8601 date, YYYY-MM-DD"2026-01-15"
SelectstringOne of the options configured for the field"sales"
🚧

All fields are returned, including manager-only fields

In MeetRox, a custom field can be restricted so that only managers can see it. The API does not apply this restriction. API keys belong to the workspace, not to an individual user, so every request returns all custom fields defined in the workspace, including those marked as visible to managers only. Keep this in mind when deciding who has access to your API key and where you store the data it returns.

Custom fields are read only through the API. To create fields or change their values, use MeetRox.

Error Responses

StatusReason
400 Bad RequestInvalid filter value (e.g., unsupported role or status)
403 ForbiddenWorkspace is disabled

Did this page help you?