GET
/
admin
/
users
import Medusa from "@medusajs/js-sdk"

export const sdk = new Medusa({
  baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
  debug: import.meta.env.DEV,
  auth: {
    type: "session",
  },
})

sdk.admin.user.list()
.then(({ users, count, limit, offset }) => {
  console.log(users)
})
{
"limit": 123,
"offset": 123,
"count": 123,
"users": [
{
"id": "<string>",
"email": "jsmith@example.com",
"first_name": "<string>",
"last_name": "<string>",
"avatar_url": "<string>",
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
}
],
"estimate_count": 123
}

Authorizations

connect.sid
string
cookie
required

Query Parameters

fields
string

Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.

offset
number

The number of items to skip when retrieving a list.

limit
number

Limit the number of items returned in the list.

order
string

The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with -.

q
string

The search term to filter the user's searchable properties.

id

Filter by a user's ID.

email
string

Filter by an email.

first_name
string

Filter by a first name.

last_name
string

Filter by a last name.

created_at
object

Filter by a user's creation date.

updated_at
object

Filter by a user's update date.

deleted_at
object

Filter by a user's deletion date.

with_deleted
boolean

Whether to include deleted records in the result.

Response

200
application/json

OK

The paginated list of users.