List All Manager Users

Retrieve all users with a Manager role (BA_MANAGER) for a Business Account. The BA_ADMIN role is required to call this API.

Endpoint

GET /v1/accounts/{accountId}/users

Authorization Header

Authorization: Bearer <access_token>
or
Authorization: Basic <encodedString>
where <encodedString> is your <api-key>:<api-secret> string encoded using Base64 encoding

Path Parameters

accountId REQUIRED

string

ID of the RocketCOMS Business Account that the user belongs to.

Query Parameters

firstName

string

User’s first name.

lastName

string

User’s last name.

string

User’s email address.

mobileNumber

string

User’s mobile number.

role

string, values: BA_ADMIN, BA_MANAGER

User’s role in the RocketCOMS Portal. Possible values are:

BA_ADMIN Business Account Administrator. Administrators can perform all actions in the Portal.
BA_MANAGER Business Account Manager. Managers can perform all actions in Portal except create users and delete users.

cityName

string, max length: 50, min length: 0

City from the user’s address.

zipCode

string, max length: 10, min length: 0

ZIP code or postal code from the user’s address.

sortBy

string

Sort the response by any field.

sortDir

string, values: desc, asc

Sort direction.

page

integer (int32), default: 0

Page number to return.

pageSize

integer (int32)

Maximum number of results to return per page.

Request Body

None

Returns

Returns a paginated response with an array of User objects.

SAMPLE RESPONSE

				
					{
  "status": "0000",
  "result": {
    "content": [
      {
        "id": "d7b0e25f-30c9-456b-b287-6b3dcaa4b8f7",
        "firstName": "John",
        "title": "Mr.",
        "signatory": true,
        "lastName": "Doe",
        "middleName": "Allan",
        "email": "abc@business.com",
        "mobileNumber": "+15555551234",
        "role": "BA_MANAGER",
        "businessAccount": {
          "id": "67b25a5e-f90a-4491-9ee4-291ff290c1fe",
          "name": "ABC Inc.",
          "legalName": "ABC Inc.",
          "operatingName": "ABC Operating",
          "legalId": "ABC 1234",
          "phoneNumber": "+15555551234",
          "email": "abc@business.com",
          "description": ""Consumer electronics",
          "website": "http://www.abc.com",
          "legalEntityType": "Corporation",
          "isActive": true,
          "address": {
            "addressType": "Work",
            "streetLine1": "123 Queen St",
            "zipCode": "10001",
            "countryCode": "US",
            "stateCode": "NY",
            "cityName": "New York"
          },
          "organizationType": "Non-Profit",
          "status": "ACTIVE",
          "createdAt": "2022-04-24T16:51:03.419Zg",
          "updatedAt": "2022-04-26T16:51:03.419Z"
        },
        "address": {
          "addressType": "Work",
          "streetLine1": "123 Queen St",
          "zipCode": "10001",
          "countryCode": "US",
          "stateCode": "NY",
          "cityName": "New York"
        },
        "passwordUpdated": true,
        "deletedAt": "2022-04-28T16:51:03.419Z",
        "isEnabled": false,
        "isAccountExpired": false,
        "createdAt": "2022-04-24T16:51:03.419Z",
        "updatedAt": "2022-04-26T16:51:03.419Z"
      },
      {...},
      {...}
    ],
    "page": 0,
    "total": 100,
    "pageSize": 10
  }
}