Get all corporate users

GET 
/v1/corporates/:id/users

Retrieves a paginated list of corporate users for a specific corporate account. Supports filtering by name, phone, and email.

Request

Path Parameters

id stringrequired

Corporate ID

Query Parameters

page number

Possible values: >= 1

Default value: 1

Page number (default: 1)

limit number

Possible values: >= 1

Default value: 10

Items per page (default: 10)

corporateId string

Filter by corporate ID

name string

Filter by user name (case-insensitive)

phone string

Filter by phone number

email string

Filter by email

Responses

200

List of corporate users retrieved successfully

application/json

Schema

Schema

data object[]required
The data of the paginated response
Array [
_id stringrequired
The ID of the corporate user
userId stringrequired
The user ID of the corporate user
firstName stringrequired
The first name of the corporate user
lastName string
The last name of the corporate user
username stringrequired
The user name of the corporate user
email stringrequired
The email of the corporate user
phone stringrequired
The phone of the corporate user
isActive booleanrequired
Whether the corporate user is active
]
total numberrequired

The total number of items

page numberrequired

The current page

limit numberrequired

The number of items per page

totalPages numberrequired

The total number of pages

Example (from schema)

{
  "data": [
    {
      "_id": "1234567890",
      "userId": "1234567890",
      "firstName": "James",
      "lastName": "Bond",
      "username": "jamesbond",
      "email": "jamesbond@goodjourney.io",
      "phone": "+1234567890",
      "isActive": true
    }
  ],
  "total": 100,
  "page": 1,
  "limit": 10,
  "totalPages": 10
}

404

Corporate not found

Loading...