---
title: "Fetching visible users"
method: GET
path: "/users"
tags: ["Users"]
---

# Fetching visible users

`GET /users`

## Request

- Base URL: `https://api.mavenlink.com/api/v1`
- URL: `https://api.mavenlink.com/api/v1/users`
- Auth: none declared

This endpoint allows you to access all visible users based on the permission level of the requester.

> **Note**: This endpoint relies on project participation and will not return a member of your account
who is not in a project. To see all users on the account, use the `on_my_account` option.

If the requester is an Account Administrator, the request will return all users who are participating in a project on the requester's account.
In addition, it will return users not on the requester's account if they are participating in any project with an account member (either on the requester's account or their own account).

If the requester is not an Account Administrator, the request will only return users who are participating in a project with the requester.


This endpoint returns structured User objects.
As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the `results` array
and will be indexed by ID in the `users` top-level JSON key.
Please see our [Response Format](#section/Response-Format) section for more information.

## Query parameters

- `account_id` integer
- `account_role_ids` string
- `all_contacts` boolean
- `assignable_to_resource` integer
- `belonging_to_orgs` string
- `by_custom_choice_value` string
- `by_custom_currency_value` string
- `by_custom_date_value` string
- `by_custom_number_value` string
- `by_custom_text_value` string
- `by_email_address` string
- `by_email_addresses` string
- `by_full_name` string
- `by_full_name_or_account_role` string
- `can_be_approver_in_workspace` integer
- `can_view_reports` boolean
- `clients_only` boolean
- `consultants_only` boolean
- `contacts_on_different_account` boolean
- `created_after` string, date-time
- `created_before` string, date-time
- `external_reference_external_message` string
- `external_reference_external_status` string
- `external_reference_service_model` string
- `external_reference_service_model_ref` integer
- `external_reference_service_model_refs` string
- `external_reference_service_name` string
- `external_reference_status` string
- `has_external_references` boolean
- `has_value_for_custom_field_ids` string
- `include` string
- `is_project_lead` boolean
- `managers` boolean
- `matching` string
- `not_assigned_to` integer
- `not_following` integer
- `not_on_calendars` string
- `not_participant_in` integer
- `on_my_account` boolean
- `on_my_account_or_participant_in_workspace` integer
- `only` string
- `only_possible_managees` boolean
- `only_possible_managers` boolean
- `optional_fields` string[]
- `order` string
- `page` integer
- `participant_in` integer
- `per_page` integer
- `potential_followers_for_story` integer
- `provider_leads_on_account_projects` boolean
- `search` string
- `show_disabled` boolean
- `show_users_in_insights_groups` boolean
- `updated_after` string, date-time
- `updated_before` string, date-time
- `with_created_estimates` boolean
- `with_organizations` boolean
- `with_skills` string
- `with_users` integer[]
- `without_external_reference_service_name` string
- `without_skills` string
- `without_timesheet_submission` string
- `without_users` integer[]
- `write_access_in` integer

## Response `200`

A list of Users have been retrieved.

- object
  - `count` integer
  - `meta` object
    - `count` integer
    - `page_count` integer
    - `page_number` integer
    - `page_size` integer
  - `results` object[]
    - `key` string
    - `id` string
  - `users` object
  - `external_references` object
  - `roles` object
  - `skills` object
  - `skill_memberships` object
  - `account_memberships` object
  - `work_samples` object
  - `custom_field_values` object

## Other responses

- `400`: Bad Request
- `401`: Unauthorized request
- `403`: Forbidden request
- `404`: Page Not Found
- `422`: Unprocessable Entity
- `503`: Service is unavailable

---

[API](https://skmtc.dev/kantata/apis/kantata-ox-api-documentation.md) - [All operations](https://skmtc.dev/kantata/apis/kantata-ox-api-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/kantata/apis/kantata-ox-api-documentation/revisions/9d4ebed2fa98?raw)