> ## 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 deal accounts > Get end-customer accounts and their opportunity contacts from opportunities registered under the authenticated partner organization, for prefilling deal registration. ```http POST https://api2.rhombussystems.com/api/partnerportal/getPartnerDealAccounts ``` 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 `) 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 ` 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 end-customer accounts from opportunities registered under the authenticated partner organization. No fields: send `{}`. ## Response 200 OK. Content type: `application/json` - `accounts` (array | null): List of end-customer accounts with their opportunity contacts - `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) - `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/getPartnerDealAccounts: post: description: Get end-customer accounts and their opportunity contacts from opportunities registered under the authenticated partner organization, for prefilling deal registration. operationId: getPartnerDealAccounts 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 ` 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_GetPartnerDealAccountsWSRequest" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Partnerportal_GetPartnerDealAccountsWSResponse" 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 deal accounts tags: - Partner Portal Webservice components: schemas: Partnerportal_GetPartnerDealAccountsWSRequest: description: Request object for getting the end-customer accounts from opportunities registered under the authenticated partner organization. type: object Partnerportal_GetPartnerDealAccountsWSResponse: description: Response object containing the end-customer accounts from opportunities registered under the authenticated partner organization. properties: accounts: description: List of end-customer accounts with their opportunity contacts items: $ref: "#/components/schemas/Partnerportal_PartnerDealAccountType" nullable: true type: array 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 warningMsg: nullable: true type: string type: object Partnerportal_PartnerDealAccountType: description: An end-customer account from an opportunity registered under the authenticated partner organization. properties: accountId: description: Identifier of the Salesforce account nullable: true type: string city: description: Billing city of the end customer nullable: true type: string contacts: description: Contacts on the partner's opportunities for this account items: $ref: "#/components/schemas/Partnerportal_PartnerDealAccountContactType" nullable: true type: array countryCode: description: ISO billing country code of the end customer example: US nullable: true type: string governmentEntity: description: Type of government entity, for public sector accounts nullable: true type: string hubspotNoOfEmployees: description: Number of employees at the end customer company nullable: true type: string industry: description: Industry of the end customer nullable: true type: string name: description: Name of the end customer company nullable: true type: string population: description: Population served by the end customer, for public sector accounts nullable: true type: string postalCode: description: Billing postal code of the end customer nullable: true type: string stateCode: description: ISO billing state or province code of the end customer example: CA nullable: true type: string street: description: Billing street address of the end customer nullable: true type: string website: description: Website of the end customer company nullable: true type: string type: object Partnerportal_PartnerDealAccountContactType: description: A contact on an opportunity registered under the authenticated partner organization. properties: contactId: description: Identifier of the Salesforce contact nullable: true type: string email: description: Email address of the contact nullable: true type: string firstName: description: First name of the contact nullable: true type: string lastName: description: Last name of the contact nullable: true type: string phone: description: Phone number of the contact nullable: true type: string title: description: Job title of the contact 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 `. 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 ````