Users

GET Get Users

GET /organizations/{organizationId}/users

Operation ID: getUsers. Security: AmOAuth2 (sfcc.users, sfcc.users.rw).

Retrieves all users with no filtering.

Parameters

organizationId (path, OrganizationId, required) An identifier for the organization the request is being made by
Example
```
f_ecom_zzxy_prd
```
select (query, Select)
Example: select
```
(**)
```
limit (query, integer (int32)) Number of records to retrieve per request. Must be between 1 (minimum) and 200 (maximum). Defaults to 25.
Default: 25. Minimum: 1. Maximum: 200.
offset (query, integer (int32)) Used to retrieve the results based on a particular resource offset.
Default: 0. Minimum: 0.

Responses

200 Returns the collection of users

Media type: application/json. Schema: UserSearch.

Example: UserSearchResponse User collection

Example of a user search response with select=(**).

{
  "limit": 3,
  "offset": 0,
  "total": 3,
  "data": [
    {
      "login": "admin-user",
      "email": "admin@example.com",
      "firstName": "John",
      "lastName": "Doe",
      "externalId": "ext-12345",
      "disabled": false,
      "locked": false,
      "lastLoginDate": "2024-10-14",
      "passwordExpirationDate": "2025-01-14T00:00:00.000Z",
      "passwordModificationDate": "2024-10-14T10:00:00.000Z",
      "preferredDataLocale": "en-US",
      "preferredUiLocale": "en-US",
      "roles": [
        "Administrator"
      ]
    },
    {
      "login": "editor-user",
      "email": "editor@example.com",
      "firstName": "Jane",
      "lastName": "Smith",
      "externalId": "ext-67890",
      "disabled": false,
      "locked": false,
      "lastLoginDate": "2024-10-13",
      "passwordExpirationDate": "2025-01-13T00:00:00.000Z",
      "passwordModificationDate": "2024-10-13T08:00:00.000Z",
      "preferredDataLocale": "en-US",
      "preferredUiLocale": "en-US",
      "roles": [
        "ContentEditor"
      ]
    },
    {
      "login": "manager-user",
      "email": "manager@example.com",
      "firstName": "Bob",
      "lastName": "Wilson",
      "externalId": "ext-11111",
      "disabled": true,
      "locked": false,
      "lastLoginDate": "2024-09-01",
      "passwordExpirationDate": "2024-12-01T00:00:00.000Z",
      "passwordModificationDate": "2024-09-01T07:00:00.000Z",
      "preferredDataLocale": "default",
      "preferredUiLocale": "default",
      "roles": [
        "CustomManager"
      ]
    }
  ]
}