Tenant API - Content

List available recipient companies for a tenant

This resource is used to list all, or search for specific, Companies that are eligible for receiving Content from the specific Tenant. The response is a JSON list of Objects containing the eligible Companies' VAT number.

A search is done by providing the vat_number query parameter. If a search is done and the Company does not exist or have opted out of receiving Content from the Tenant an empty list will be returned.

get/v1/tenant/{tenantKey}/company

Request

  • Base URL: https://sender.api.kivra.com
  • URL: https://sender.api.kivra.com/v1/tenant/{tenantKey}/company
  • Auth: oAuth2Client (defined in the document in a form this page cannot read)

Path parameters

tenantKeystring hexadecimal required

The unique Key for a Tenant.

Query parameters

vat_numberstring

A Swedish VAT number ("momsregistreringsnummer").

Example:SE556000475501

Perform a search to see if a VAT number matches an eligible Company Recipient of the Tenant.

Response

List of Companies' keys and VAT numbers which are eligible Recipients of the Tenant.

key''

This value is deprecated and will always be set to the empty string.

vatnrstring

A Swedish VAT number ("momsregistreringsnummer").

Example response

[
  {
    "vatnr": "SE556000475501"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.