Companies

This page explains the possibilities the API provides to search and sort companies in different ways.

To get a list of the most popular companies, the query topCompanies is used. The parameter limit stands for the maximum number of companies per category to be returned. This query returns only companies that are in certain mainCategories. These categories are: #energy, #telecommunication, #insurance, #subscription and #habitation.

query {
  topCompanies(companyLimit: <LIMIT>) {
    name
    mainCategory {
      text
    }
    subCategory {
      text
    }
  }
}

Additional fields next to name, mainCategory and subCategory can be found in the AccountSwitchPartner model below.

To get a list of selected popular companies, the query topCompaniesStatic can be used.

query {
  topCompaniesStatic {
    name
    mainCategory {
      text
    }
    subCategory {
      text
    }
  }
}

Additional fields next to name, mainCategory and subCategory can be found in the AccountSwitchPartner model below.

Find companies by name

Companies can be searched via two different queries, which differ only in the filter options.

Filtered by mainCategories

The query getCompaniesByMainCategories can be used to search for companies that are filtered directly by mainCategories. The parameter limit stands for the number of companies per category. If an empty search string is passed, companies sorted by popularity and filtered by mainCategories are returned.

query {
  getCompaniesByMainCategories(name: "<NAME>", limit: <LIMIT>, mainCategories: ["#subscription"]) {
    mainCategory {
        text
    }
    subCategory {
        text
    }
    partners {
      name
    }
  }
}

Additional fields next to name can be found in the AccountSwitchPartner model below.

Filtered by subCategories

The query getCompaniesBySubCategories can be used to search for companies that are filtered directly by subCategories. The parameter limit stands for the number of companies per category. If an empty search string is passed, companies sorted by popularity and filtered by subCategories are returned.

query {
  getCompaniesBySubCategories(name: "<NAME>", limit: <LIMIT>, subCategories: ["#musicStreaming"]) {
    mainCategory {
        text
    }
    subCategory {
        text
    }
    partners {
      name
    }
  }
}

Additional fields next to name can be found in the AccountSwitchPartner model below.

Company Models

AccountSwitchPartner

type ContractPartner {

    accountId: String

    partnerId: String

    ignore: Boolean

    incomplete: Boolean

    mref: String

    address: String

    mainCategory : Translatable

    subCategory : Translatable

    city: String

    postcode: String

    country: String

    changeUrl: String

    creditorId: String

    email: String

    fax: String

    name: String

    phone: String

    preferredContact: String

    www: String

    latestTransaction: AccountSwitchTransaction,

    logoUrl : String
}