APappdirect
AppResellerCompanyAssociation

List company associations

Changed on

Retrieves all customer company associations. This request requires either the Reseller company ID or the Customer company ID, which you can retrieve with the List companies request.

get/appReseller/v1/companyAssociations

Request

Query parameters

resellerCompanyIdstring required

Reseller company ID. This field is required if you do not include the Customer company ID

customerCompanyIdstring required

Customer company ID. This field is required if you do not include the Reseller company ID

searchTextstring

Search term used to search on different fields of the customer company association.

createdOnstring

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'

sortstring

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

numberinteger

Page number

sizeinteger

Number of results per page

Response

Success

Example response

{
  "page": {
    "number": 12345,
    "size": 12345,
    "totalElements": 12345,
    "totalPages": 12345
  },
  "content": [
    {
      "resellerCompany": {
        "id": "698555fc-bc65-4163-9fee-16308edec41b",
        "name": "Company A"
      },
      "customerCompany": {
        "id": "698555fc-bc65-4163-9fee-16308edec41b",
        "name": "Company A"
      }
    }
  ]
}

Changes

  • 1fc240f06971Revision changes
    • breaking

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

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status