Partner Portal

Get partner portal lead dashboard leads

Get the Salesforce leads registered under the authenticated partner organization, newest first.

POST/api/partnerportal/getPartnerPortalLeadDashboardLeads

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 getting the lead dashboard leads belonging to the authenticated partner organization.

bash

curl --request POST \
  --url 'https://api2.rhombussystems.com/api/partnerportal/getPartnerPortalLeadDashboardLeads' \
  --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/getPartnerPortalLeadDashboardLeads"
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/getPartnerPortalLeadDashboardLeads', {
  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/getPartnerPortalLeadDashboardLeads"))
            .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

{
  "error": false,
  "errorCode": "<string>",
  "leads": [
    {
      "aeDeniedReason": "<string>",
      "city": "<string>",
      "company": "<string>",
      "country": "<string>",
      "createdDate": "<string>",
      "email": "<string>",
      "firstName": "<string>",
      "formSubmissionType": "<string>",
      "id": "<string>",
      "impartnerLeadOwnerText": "<string>",
      "isConverted": true,
      "lastName": "<string>",
      "leadSource": "<string>",
      "leadSourceSecondary": "<string>",
      "ownerName": "<string>",
      "partnerAccountName": "<string>",
      "partnerContactId": "<string>",
      "partnerContactName": "<string>",
      "phone": "<string>",
      "postalCode": "<string>",
      "state": "<string>",
      "status": "<string>",
      "street": "<string>",
      "title": "<string>",
      "website": "<string>"
    }
  ]
}

Response

200 OK

application/json · object

Response object containing the lead dashboard leads belonging to the authenticated 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

leadsobject[] | null

List of leads registered under the partner organization, newest first

Show child attributes

aeDeniedReasonstring | null

Reason the account executive denied the lead

citystring | null

City of the lead

companystring | null

Company the lead belongs to

countrystring | null

Country of the lead

createdDatestring | null

Date the lead was created, in MM/DD/YYYY format based on the UTC calendar date (for example 01/15/2026)

emailstring | null

Email address of the lead

firstNamestring | null

First name of the lead

formSubmissionTypestring | null

Type of the form the lead was submitted through

idstring | null

Salesforce record id of the lead

impartnerLeadOwnerTextstring | null

Name of the Impartner lead owner

isConvertedboolean | null

Whether the lead has been converted to an opportunity

lastNamestring | null

Last name of the lead

leadSourcestring | null

Lead source of the lead

leadSourceSecondarystring | null

Secondary lead source of the lead

ownerNamestring | null

Name of the owner of the lead

partnerAccountNamestring | null

Name of the partner account associated with the lead

partnerContactIdstring | null

Salesforce record id of the partner contact associated with the lead

partnerContactNamestring | null

Name of the partner contact associated with the lead

phonestring | null

Phone number of the lead

postalCodestring | null

Postal code of the lead

statestring | null

State or province of the lead

statusstring | null

Current status of the lead

streetstring | null

Street address of the lead

titlestring | null

Job title of the lead

websitestring | null

Website of the lead's company

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.