APappdirect
AppResellerOpportunities

List opportunities

Changed on

Retrieve a list of opportunities. Returned opportunities are limited to role visibility: Marketplace Manager, Partner, Partner Read: all opportunities. Reseller Manager: all opportunities owned by Reseller companies. Reseller, SSR: all opportunities owned by the company to which the Reseller or SSR belongs. When users have multiple roles, visibility is the sum of visibility for all their roles. Additional filter parameters are available for some roles.

Required: Accept-Language header with Locale format. For example: en-US

get/assistedSales/v1/opportunities

Request

Query parameters

ownerIdstring

Sales agent's user ID

ownerCompanyIdstring

Sales agent's company ID, which defines which company owns opportunities. This is an optional filter to only return opportunities that the sale's agent's company owns. Only valid for Marketplace Manager, Reseller Manager, Partner, and Partner Read roles (invalid for Reseller and SSR roles because they can only see opportunities owned by their company). No opportunities are returned when the call is filtered by a company ID for which the user does not have access.

customerIdstring

Customer's user ID

customerCompanyIdstring

Customer's company ID

context'RESELLER' | 'SSR'

Optional. For Marketplace Manager, Partner, and Partner Read roles, filter the returned opportunities by those owned by SSRs or Resellers.

status'OPEN' | 'CLOSED' | 'PENDING_REVIEW'

Opportunity status

purchaseEffectiveDatestring[]

Opportunity purchase effective date filter, defined by upper or lower inclusive or exclusive limits, in Unix timestamp format. Acceptable values are: gte([timestamp]) - 'greater than or equal to'; or lte([timestamp]) - 'less than or equal to'

createdOnstring[]

Opportunity creation date filter, defined by upper or lower inclusive or exclusive limits, in Unix timestamp format. Acceptable values are: gte([timestamp]) - 'greater than or equal to'; or lte([timestamp]) - 'less than or equal to'

searchTextstring

General text search filter used for any ID (opportunity, sales agent, sales agent company, customer, or customer company) and opportunity name

numberinteger

Page number

sizeinteger

Number of results per page

sortstring

Sort field and order. For ascending sort order, use the '+[FieldName]' format. For descending order, use the '-[FieldName]' format.

Response

Success

Example response

{
  "page": {
    "number": 12345,
    "size": 12345,
    "totalElements": 12345,
    "totalPages": 12345
  },
  "content": [
    {
      "id": "ef6c414f-39da-401f-a4b8-81adc6190fda",
      "name": "Jarvis Iniative",
      "ownerUser": {
        "id": "d781ac09-b4fe-4d57-8ba2-4640fc5b7c49",
        "email": "john.doe@acme.com",
        "firstName": "John",
        "lastName": "Doe",
        "company": {
          "id": "1",
          "name": "Acme Corp.",
          "isReseller": true
        }
      },
      "customerUser": {
        "id": "498c62ea-ad14-48e6-96ce-5400c617444c",
        "email": "ubrownfield@stark.com",
        "firstName": "Ulysses",
        "lastName": "Brownfield",
        "company": {
          "id": "100",
          "name": "Customer Company",
          "isReseller": false
        }
      },
      "createdOn": 1557861989000,
      "purchaseEffectiveDate": 1577750400000,
      "status": "CLOSED",
      "ownerType": "PLATFORM_OWNER"
    }
  ]
}

Changes

  • 1fc240f06971Revision changes
    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • info

      added the new optional query request parameter status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status