home

Medallia Experience Cloud

Medallia Experience CloudMedallia Digital FeedbackMedallia Agile ResearchDigital Experience AnalyticsMedallia VideoAgent ConnectMedallia Experience OrchestrationMindfulMedallia IdeasVociSense360Medallia CompanyGlossary
Medallia Experience CloudMedallia Digital FeedbackMedallia Agile ResearchDigital Experience AnalyticsMedallia VideoAgent ConnectMedallia Experience OrchestrationMindfulMedallia IdeasVociSense360Medallia CompanyGlossary

Show Contents

thumbnailMedallia Experience Cloud

Users

Lists all users

get
https://{api-gateway-hostname}
/admin/v1/users

Lists all users

Request

Query Parameters

companyAccountId
array[string]

The company account id to filter results

cursor
string

The token from the previous response, used to return the next page of data

limit
integer

The maximum number of items to return per page

role
string

The role name to filter results

status
string

The user status to filter results

Allowed values:
activeinactive
username
array[string]

The user name to filter results

Responses

The users that match the filters provided

Headers

X-Medallia-Rpc-Request-Id
string<identifier>

The request ID, used by Medallia support for troubleshooting

Example:
94615edd-d9d0-4921-8b3e-60615b3d3431
X-RateLimit-Limit
string

Indicates the request quota closest to reaching its limit amongst all available quotas. Follows the semantics of IETF draft-polli-ratelimit-headers.

Example:
10, 10;w=1, 100;w=86400
X-RateLimit-Limit-day
integer
deprecated

The number of requests allowed in total in a 24-hour period. Deprecated as of Sept. 2022 in favor of X-RateLimit-Limit.

Example:
10000
X-RateLimit-Limit-second
integer
deprecated

The number of requests allowed in total in a 1-second period. Deprecated as of Sept. 2022 in favor of X-RateLimit-Limit.

Example:
10
X-RateLimit-Remaining
integer

Indicates the number of requests remaining in the quota that is closest to expiring (as indicated by X-RateLimit-Limit). Follows the semantics of IETF draft-polli-ratelimit-headers.

Example:
10
X-RateLimit-Remaining-day
integer
deprecated

The number of requests available to make in a 24-hour period. Deprecated as of Sept. 2022 in favor of X-RateLimit-Remaining.

Example:
10000
X-RateLimit-Remaining-second
integer
deprecated

The number of requests available to make in a 1-second period. Deprecated as of Sept. 2022 in favor of X-RateLimit-Remaining.

Example:
10
X-RateLimit-Reset
integer

Indicates the number of seconds remaining until the quota resets. Follows the semantics of IETF draft-polli-ratelimit-headers.

Example:
10

Body

responses
/
200

A list of users

items
array[object]
username
string<identifier>
required

The username used to identify the account

<= 10240 characters
Match pattern:
^[a-zA-Z0-9\\-_.@]+$
first_name
string
required

The first name of the user

<= 10240 characters
last_name
string
required

The last name of the user

<= 10240 characters
email
string<email>

The email address of the user

phone
string

The phone number of the user

<= 10240 characters
automatic_update
boolean

Indicates whether the user account is able to be automatically updated by Medallia ETL processes

excluded_from_user_activity
boolean

Indicates whether the user account is included in user-activity-account-split nodes in Medallia AA2 reports

company_account_id
string

The user's account ID in the company's authentication systems, set automatically during auto-logon processes

<= 10240 characters
login_blocked
boolean

Indicates whether the direct-to-Medallia user logins are blocked and, as a consequence, password resets are also blocked. This has no bearing on SSO-based authentication or mobile access codes.

data-access
object

Data access ensures a user only sees the records for which they have permission

roles
object
required

The roles of which this account is a member

_system_properties
object
_next
object
href
string

Link to the next page in the result set

<= 10240 characters
Auth
:
Server Variables
:
Parameters
:
:
:
:
:
:
curl --request GET \
  --url https://instance-tenant.apis.medallia.com/admin/v1/users \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer 123'
Response Example
1
{
2
  "items": [
3
    {
4
      "username": "string",
5
      "first_name": "string",
6
      "last_name": "string",
7
      "email": "user@example.com",
8
      "phone": "string",
9
      "automatic_update": true,
10
      "excluded_from_user_activity": true,
11
      "company_account_id": "string",
12
      "login_blocked": true,
13
      "data-access": {
14
        "organization": [
15
          {
16
            "role": "string",
17
            "data_view": "string",
18
            "unit_group": "string",
19
            "unit_group_display_name": "string"
20
          }
21
        ],
22
        "segments": [
23
          {
24
            "role": "string",
25
            "data_view": "string",
26
            "field": "string",
27
            "field_display_name": "string",
28
            "option": "string"
29
          }
30
        ]
31
      },
32
      "roles": {
33
        "primary_role": {
34
          "role": "string"
35
        },
36
        "extra_roles": [
37
          {
38
            "role": "string"
39
          }
40
        ]
41
      },
42
      "_system_properties": {
43
        "status": "ACTIVE",
44
        "created_on": "2019-08-24T14:15:22Z",
45
        "created_by": "string",
46
        "modified_on": "2019-08-24T14:15:22Z",
47
        "modified_by": "string",
48
        "login_blocked_reason": "TOO_MANY_FAILED_LOGINS",
49
        "last_login": "2019-08-24T14:15:22Z",
50
        "login_count": 0,
51
        "failed_login_count": 0,
52
        "password_last_set": "2019-08-24T14:15:22Z",
53
        "password_last_emailed": "2019-08-24T14:15:22Z",
54
        "password_not_set_reason": "PASSWORD_RESET"
55
      }
56
    }
57
  ],
58
  "_next": {
59
    "href": "string"
60
  }
61
}

Explore Medallia Documentation

Medallia Experience Cloud

Medallia Digital Feedback

Medallia Agile Research

Digital Experience Analytics

Medallia Video

Agent Connect

Medallia Experience Orchestration

Mindful

Medallia Ideas

Voci

Sense360

Medallia Company

Glossary

Medallia Concierge

Medallia Developer Portal

logo

Company

Knowledge Center

Legal

About Medallia

Developer Portal

Privacy Policy

Contact Support

Trust

Copyright © 2025 Medallia, Inc. All rights reserved.
Medallia®, the Medallia logo, and the names and marks associated with Medallia’s products are trademarks of Medallia and/or its affiliates. All other trademarks are the property of their respective owners.