RECENT UPDATES:
05-Jun-2026 | v7.10.7 | All new article

Change Log

  • 05-Jun-2026 | v7.10.7 | All new article

Contributors:

{
  "id": 2418,
  "name": "Adam Wilson",
  "url": "/adam-wilson"
}
Adam Wilson - Logo Pogo

Admin Users API

Create, Retrieve, Update and Delete Admin Users via the public API endpoint using "where" filtering. Admin User invitations can also be re-sent via this API.

GET Admin Users List

Retrieves a list of Admin Users as a JSON response based on your provided query parameters.

/api/v2/admin/admin-users

Parameters

Parameter
Values
Required
Where
{<where query>}
Order_By
<propertyAlias>
Semantic_Query
<string>
Min_Score
<double>
Offset
<integer>
Limit
<integer>

Data / Response:

N/A

{
  "Items": [
    {
      "Id": 0,
      "IsInvited": true,
      "FirstName": "string",
      "LastName": "string",
      "Email": "user@example.com",
      "EnableOse": true,
      "UserId": 0,
      "RoleId": 0
    }
  ],
  "TotalItemsCount": 0
}

POST Admin User Create

Creates a new Admin User based on the provided data.

/api/v2/admin/admin-users

Data / Response:

{
  "FirstName": "string",
  "LastName": "string",
  "Email": "user@example.com",
  "EnableOse": true,
  "Role": 0
}

{
  "Id": 0,
  "IsInvited": true,
  "FirstName": "string",
  "LastName": "string",
  "Email": "user@example.com",
  "EnableOse": true,
  "UserId": 0,
  "RoleId": 0
}

GET Admin User Item

Retrieves a single Admin User based on the ID passed in the endpoint URL.

/api/v2/admin/admin-users/{id}

Data / Response:

N/A

{
  "Id": 0,
  "IsInvited": true,
  "FirstName": "string",
  "LastName": "string",
  "Email": "user@example.com",
  "EnableOse": true,
  "UserId": 0,
  "RoleId": 0
}

PUT Admin User Update

Updates a single Admin User based on the ID passed in the endpoint URL and data provided.

/api/v2/admin/admin-users/{id}

Data / Response:

{
  "EnableOse": true,
  "Role": 0
}

{
  "Id": 0,
  "IsInvited": true,
  "FirstName": "string",
  "LastName": "string",
  "Email": "user@example.com",
  "EnableOse": true,
  "UserId": 0,
  "RoleId": 0
}

DELETE Admin User Delete

Deletes a single Admin User based on the ID passed in the endpoint URL.

/api/v2/admin/admin-users/{id}

Data / Response:

N/A

Status 204

POST Admin User Re-invite

Re-sends an invitation to an Admin User based on the ID passed in the endpoint URL.

/api/v2/admin/admin-users/{id}/re-invite

Data / Response:

N/A

{
  "Id": 0,
  "IsInvited": true,
  "FirstName": "string",
  "LastName": "string",
  "Email": "user@example.com",
  "EnableOse": true,
  "UserId": 0,
  "RoleId": 0
}