Retrieve a Manager User

Retrieve details for a user with a Manager role (BA_MANAGER). The BA_ADMIN or BA_MANAGER role is required to call this API.

Endpoint

GET /v1/accounts/{accountId}/users/{userId}

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.

userId REQUIRED

string (UUID)

Unique ID assigned to the user in RocketCOMS.

Request Body

None

Returns

Returns details for the user. Details for the Business Account the user belongs to are also returned. For details, see the User object.

SAMPLE RESPONSE

				
					{
  "status": "0000",
  "result": {
    "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"
  }
}