MImistral
beta.admin.users

Get Users

Changed on

List Organization members and pending invitations.

get/v1/admin/users

Request

Query parameters

pageinteger

Page number to return.

page_sizeinteger

Maximum number of results per page.

emailstring nullable

Email address to filter users and invitations.

Example:alice.martin@example.com

Response

OK

totalinteger nullable required

Total number of users and invitations that match the request.

pageinteger nullable required

Page number returned.

page_sizeinteger nullable required

Maximum number of results per page.

Example response

{
  "members": [
    {
      "name": "Alice Martin",
      "email": "alice.martin@example.com",
      "workspaces": [
        {
          "name": "Product Team"
        }
      ]
    }
  ],
  "invites": [
    {
      "email": "alice.martin@example.com"
    }
  ]
}

Changes

  • 6c349f3bdef6Revision changes
    • warning

      added the new 7e69e493-caf6-4671-af60-84951754d9fc enum value to the ////// response property for the response status

    • warning

      added the new 7e69e493-caf6-4671-af60-84951754d9fc enum value to the /////// response property for the response status

    • warning

      added the new 94ef59cf-56bf-4383-9dd6-1fee77d370af enum value to the ////// response property for the response status

    • warning

      added the new 94ef59cf-56bf-4383-9dd6-1fee77d370af enum value to the /////// response property for the response status

  • fa73befe1c61Revision changes
    • warning

      for the query request parameter page_size, the max was set to 100.00

    • warning

      added the new 348fc8da-f6da-4464-ad3e-af7bc137e221 enum value to the ////// response property for the response status

    • warning

      added the new 348fc8da-f6da-4464-ad3e-af7bc137e221 enum value to the /////// response property for the response status

    • warning

      added the new IC enum value to the ///// response property for the response status

    • warning

      added the new PC enum value to the ///// response property for the response status