Partner Portal

Get partner portal company info

Get the company profile of the authenticated partner organization: contact details, billing address, and the partner types, access control platforms and services it offers.

POST/api/partnerportal/getCompanyInfo

Authorizations

x-auth-apikeystringheaderrequired

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Authorizationstringheader

Instead of an API key, an OAuth access token: Bearer <token>, with the read scope.

OAuth explains tokens and scopes.

Headers

x-auth-schemeenum<string>headerdefault: partner-api-token

Authentication scheme identifier. Use api-token or partner-api-token with the x-auth-apikey header, api or partner-api with x-auth-apikey plus a client certificate, api-oauth-token or partner-api-oauth-token with x-auth-access-token, and federated-token with x-auth-ft. A request with Authorization: Bearer <token> and no x-auth-scheme is treated as OAuth, and federated-token may also be sent as the x-auth-scheme and x-auth-ft query parameters.

Available options: api-token, api, api-oauth-token, federated-token, partner-api-token, partner-api, partner-api-oauth-token

Body

application/json · object

Request object for reading the company profile of the authenticated partner organization. This request carries no fields: the partner organization is resolved from the authenticated session.

bash

curl --request POST \
  --url 'https://api2.rhombussystems.com/api/partnerportal/getCompanyInfo' \
  --header 'x-auth-scheme: partner-api-token' \
  --header 'x-auth-apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

url = "https://api2.rhombussystems.com/api/partnerportal/getCompanyInfo"
headers = {
    "x-auth-scheme": "partner-api-token",
    "x-auth-apikey": "YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
print(response.json())

const response = await fetch('https://api2.rhombussystems.com/api/partnerportal/getCompanyInfo', {
  method: 'POST',
  headers: {
    'x-auth-scheme': 'partner-api-token',
    'x-auth-apikey': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);

console.log(await response.json());

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        String body = """
            {}
            """;
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api2.rhombussystems.com/api/partnerportal/getCompanyInfo"))
            .header("x-auth-scheme", "partner-api-token")
            .header("x-auth-apikey", "YOUR_API_KEY")
            .header("Content-Type", "application/json")
            .method("POST", HttpRequest.BodyPublishers.ofString(body))
            .build();
        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}

json

{
  "companyInfo": {
    "accessControl": [
      "<string>"
    ],
    "accountType": "<string>",
    "alarmMonitoringApproved": true,
    "billingCity": "<string>",
    "billingCountry": "<string>",
    "billingCountryCode": "<string>",
    "billingPostalCode": "<string>",
    "billingState": "<string>",
    "billingStateCode": "<string>",
    "billingStreet": "<string>",
    "competitorsResellerOffers": [
      "<string>"
    ],
    "confirmedAccessControlQualifications": true,
    "name": "<string>",
    "offeredServices": [
      "<string>"
    ],
    "partnerType": [
      "<string>"
    ],
    "phone": "<string>",
    "resellerStatus": "<string>",
    "resellerTier": "<string>",
    "servicesGeographicCoverage": "<string>",
    "website": "<string>"
  },
  "error": false,
  "errorCode": "<string>"
}

Response

200 OK

application/json · object

Response object containing the company profile of the authenticated partner organization.

companyInfoobject

The company profile of a partner organization, projected down to the fields a partner may see.

Show child attributes

accessControlstring[] | null

Access control platforms the organization works with, as Salesforce multi-select picklist values. Empty, never null.

accountTypestring | null

Salesforce account type of the partner organization. Read only.

alarmMonitoringApprovedboolean | null

Whether the partner organization is approved for alarm monitoring

billingCitystring | null

Billing city of the partner organization

billingCountrystring | null

Billing country as a display name (for example United States). Provided for display only: the update endpoint accepts only the ISO code, billingCountryCode.

billingCountryCodestring | null

Billing country as an ISO code (for example US). This is the form the update endpoint accepts.

billingPostalCodestring | null

Billing postal code of the partner organization

billingStatestring | null

Billing state as a display name (for example California). Provided for display only: the update endpoint accepts only the ISO code, billingStateCode.

billingStateCodestring | null

Billing state as an ISO code (for example CA). This is the form the update endpoint accepts.

billingStreetstring | null

Billing street of the partner organization

competitorsResellerOffersstring[] | null

Competitor offerings the organization also resells, as Salesforce multi-select picklist values. Empty, never null.

confirmedAccessControlQualificationsboolean | null

Whether the partner organization has confirmed its access control qualifications

namestring | null

Name of the partner organization. Read only; the update endpoint rejects it.

offeredServicesstring[] | null

Services the organization offers, as Salesforce multi-select picklist values. Empty, never null.

partnerTypestring[] | null

Partner types the organization operates as, as Salesforce multi-select picklist values. Empty, never null.

phonestring | null

Primary phone number of the partner organization

resellerStatusstring | null

Reseller status of the partner organization. Read only. One of Pending, Denied, Approved, Credit Hold, Terminated, Approved - Monitoring, Unknown.

resellerTierstring | null

Reseller tier of the partner organization. Read only; the update endpoint rejects it.

servicesGeographicCoveragestring | null

Geographic coverage of the services the partner organization offers

websitestring | null

Website of the partner organization

errorboolean | null

errorCodestring | null

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring | null

warningMsgstring | null

Errors

Like every operation, this one can also answer with the standard error body (errorCode, errorMsg). Errors explains each status and how to retry.

400 Bad Request. errorCode is one of: BAD_REQUEST, VALIDATION_FAILED, MISSING_REQUIRED_FIELD, INVALID_JSON, INVALID_REQUEST_BODY, FEATURE_NOT_ENABLED, INVALID_AUTH_ORG, LOCATION_NOT_FOUND, SELF_PROVISIONING_DISABLED, SKU_NOT_ALLOWED, QUANTITY_INVALID, AUTO_RENEW_REQUIRED, PROVISION_CAP_EXCEEDED, ACKNOWLEDGEMENT_REQUIRED, SIGNATURE_REQUIRED, APEX_VALIDATION, SKU_NOT_IN_PRICEBOOK.
401 Unauthorized. errorCode is one of: UNAUTHENTICATED, INVALID_CREDENTIAL, CREDENTIAL_EXPIRED, CREDENTIAL_REVOKED, CERTIFICATE_MISMATCH.
403 Forbidden. errorCode is one of: FORBIDDEN, DOMAIN_NOT_ALLOWED, DEVICE_SCOPE_MISMATCH, ROLE_NOT_PERMITTED, FUNCTIONALITY_REQUIRED, PARTNER_FUNCTIONALITY_REQUIRED, PERMISSION_REQUIRED, PARTNER_CLIENT_ACCESS_DENIED, HARDWARE_NOT_AVAILABLE, HARDWARE_ALREADY_REGISTERED, PARTNER_PORTAL_NOT_ENABLED, MANAGED_BY_MSP, SUPER_ADMIN_RESTRICTED_BY_MSP, MSP_DESIGNATION_INVALID, NOT_MANAGED_CLIENT, NOT_VERIFIED_MSP, ORDER_NOT_YOURS.
429 Too Many Requests. errorCode is one of: RATE_LIMITED, QUOTE_RATE_LIMITED.
500 Internal Server Error. errorCode is one of: INTERNAL_ERROR.
503 Service Unavailable. errorCode is one of: SERVICE_UNAVAILABLE, SALESFORCE_UNAVAILABLE.