Skip to main content
GET
/
api
/
public
/
v1
/
companies
/
users
List company users
curl --request GET \
  --url https://app.msportal.ai/api/public/v1/companies/users \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "email": "[email protected]",
      "fullName": "<string>",
      "avatarUrl": "<string>",
      "status": "active",
      "lastLogin": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "role": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      },
      "company": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      }
    }
  ],
  "pagination": {
    "page": 2,
    "limit": 50,
    "totalCount": 123,
    "totalPages": 123,
    "hasNextPage": true,
    "hasPrevPage": true
  }
}

Authorizations

​
Authorization
string
header
required

Use your API key as a Bearer token. API keys can be generated in Settings → Integrations → API Access.

Query Parameters

​
page
number
default:1

Page number

Required range: x >= 1
​
limit
number
default:25

Items per page (max 50)

Required range: 1 <= x <= 50
​
sortColumn
enum<string>
default:full_name

Field to sort by

Available options:
full_name,
email,
status,
created_at,
last_login,
company_name
​
sortDesc
boolean | null
default:false

Sort descending

​
search
string

Search in name and email

Maximum string length: 255
​
status
enum<string>

Filter by user status

Available options:
active,
disabled,
pending,
imported
​
roleId
string<uuid>

Filter by role ID

​
companyId
string<uuid>

Filter by company ID

Response

List of company users

​
data
object[]
required

Array of company users

​
pagination
object
required