> ## Documentation index
> Fetch the complete documentation index at: https://developer.rhombus.com/llms.txt
> Use it to discover all available pages before exploring further.

# Get partner portal lead dashboard leads

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

```http
POST https://api2.rhombussystems.com/api/partnerportal/getPartnerPortalLeadDashboardLeads
```

EU organizations send the same request to `https://api2.eu.rhombussystems.com`.

## Authentication and parameters

- `x-auth-apikey` (header, required): Your Rhombus API key. Must be accompanied by the `x-auth-scheme` header set to `api-token` (or `partner-api-token` for partner endpoints).
- `Authorization` (header): instead of an API key, an OAuth access token (`Bearer <token>`) with the `read` scope.
- `x-auth-scheme` (header, string, default: `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. One of: `api-token`, `api`, `api-oauth-token`, `federated-token`, `partner-api-token`, `partner-api`, `partner-api-oauth-token`.

## Request body

Content type: `application/json`. Request object for getting the lead dashboard leads belonging to the authenticated partner organization.

No fields: send `{}`.

## Response 200

OK. Content type: `application/json`

- `error` (boolean | null)
- `errorCode` (string | null): Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.
- `errorMsg` (string | null)
- `leads` (array<object> | null): List of leads registered under the partner organization, newest first
- `warningMsg` (string | null)

## Errors

Also 400, 401, 403, 429, 500, 503 with the standard error body (`errorCode`, `errorMsg`): https://developer.rhombus.com/errors

## OpenAPI

````yaml
openapi: 3.0.1
info:
  title: Rhombus API
  version: "1.0"
servers:
  - description: Production Server
    url: https://api2.rhombussystems.com
security:
  - ApiKeyAuth: []
paths:
  /api/partnerportal/getPartnerPortalLeadDashboardLeads:
    post:
      description: Get the Salesforce leads registered under the authenticated partner organization, newest first.
      operationId: getPartnerPortalLeadDashboardLeads
      parameters:
        - description: "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."
          example: partner-api-token
          in: header
          name: x-auth-scheme
          required: false
          schema:
            default: partner-api-token
            enum:
              - api-token
              - api
              - api-oauth-token
              - federated-token
              - partner-api-token
              - partner-api
              - partner-api-oauth-token
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Partnerportal_GetPartnerPortalLeadDashboardLeadsWSRequest"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Partnerportal_GetPartnerPortalLeadDashboardLeadsWSResponse"
          description: OK
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
        "429":
          $ref: "#/components/responses/TooManyRequests"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "503":
          $ref: "#/components/responses/ServiceUnavailable"
      security:
        - ApiKeyAuth: []
        - oauth2:
            - read
      summary: Get partner portal lead dashboard leads
      tags:
        - Partner Portal Webservice
components:
  schemas:
    Partnerportal_GetPartnerPortalLeadDashboardLeadsWSRequest:
      description: Request object for getting the lead dashboard leads belonging to the authenticated partner organization.
      type: object
    Partnerportal_GetPartnerPortalLeadDashboardLeadsWSResponse:
      description: Response object containing the lead dashboard leads belonging to the authenticated partner organization.
      properties:
        error:
          nullable: true
          type: boolean
        errorCode:
          description: Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.
          nullable: true
          type: string
        errorMsg:
          nullable: true
          type: string
        leads:
          description: List of leads registered under the partner organization, newest first
          items:
            $ref: "#/components/schemas/Partnerportal_PartnerPortalLeadDashboardLeadType"
          nullable: true
          type: array
        warningMsg:
          nullable: true
          type: string
      type: object
    Partnerportal_PartnerPortalLeadDashboardLeadType:
      description: Information about a single lead displayed on the partner portal lead dashboard.
      properties:
        aeDeniedReason:
          description: Reason the account executive denied the lead
          nullable: true
          type: string
        city:
          description: City of the lead
          nullable: true
          type: string
        company:
          description: Company the lead belongs to
          nullable: true
          type: string
        country:
          description: Country of the lead
          nullable: true
          type: string
        createdDate:
          description: Date the lead was created, in MM/DD/YYYY format based on the UTC calendar date (for example 01/15/2026)
          nullable: true
          type: string
        email:
          description: Email address of the lead
          nullable: true
          type: string
        firstName:
          description: First name of the lead
          nullable: true
          type: string
        formSubmissionType:
          description: Type of the form the lead was submitted through
          nullable: true
          type: string
        id:
          description: Salesforce record id of the lead
          nullable: true
          type: string
        impartnerLeadOwnerText:
          description: Name of the Impartner lead owner
          nullable: true
          type: string
        isConverted:
          description: Whether the lead has been converted to an opportunity
          nullable: true
          type: boolean
        lastName:
          description: Last name of the lead
          nullable: true
          type: string
        leadSource:
          description: Lead source of the lead
          nullable: true
          type: string
        leadSourceSecondary:
          description: Secondary lead source of the lead
          nullable: true
          type: string
        ownerName:
          description: Name of the owner of the lead
          nullable: true
          type: string
        partnerAccountName:
          description: Name of the partner account associated with the lead
          nullable: true
          type: string
        partnerContactId:
          description: Salesforce record id of the partner contact associated with the lead
          nullable: true
          type: string
        partnerContactName:
          description: Name of the partner contact associated with the lead
          nullable: true
          type: string
        phone:
          description: Phone number of the lead
          nullable: true
          type: string
        postalCode:
          description: Postal code of the lead
          nullable: true
          type: string
        state:
          description: State or province of the lead
          nullable: true
          type: string
        status:
          description: Current status of the lead
          nullable: true
          type: string
        street:
          description: Street address of the lead
          nullable: true
          type: string
        title:
          description: Job title of the lead
          nullable: true
          type: string
        website:
          description: Website of the lead's company
          nullable: true
          type: string
      type: object
  securitySchemes:
    ApiKeyAuth:
      description: Your Rhombus API key. Must be accompanied by the `x-auth-scheme` header set to `api-token` (or `partner-api-token` for partner endpoints).
      in: header
      name: x-auth-apikey
      type: apiKey
    oauth2:
      description: 'OAuth 2.0 authorization code flow with PKCE (`S256`). Send the access token as `Authorization: Bearer <token>`. Each operation lists the scopes it requires; a token without them is refused 403 with `WWW-Authenticate: Bearer error="insufficient_scope"`.'
      flows:
        authorizationCode:
          authorizationUrl: https://console.rhombus.com/oauth/authorize
          refreshUrl: https://auth-web.rhombussystems.com/oauth/token
          scopes:
            physical: Unlock doors and elevators, lockdown, alarms, speakers and robots
            read: View cameras, footage and settings
            write: Change settings and data
          tokenUrl: https://auth-web.rhombussystems.com/oauth/token
      type: oauth2
````