Tenant API - Tenant Management

Tenant information

Get detailed information on a tenant

get/v2/tenant/{tenantKey}

Request

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

Path parameters

tenantKeystring hexadecimal required

The unique Key for a Tenant

Response

Tenant information

namestring required

Name of the Tenant, this name shows up in the Users Inbox

edit_security_level25 | 50

Security level needed for an enduser to opt_out from this Tenant

groupsstring[]

List of groups this Tenant belongs to

visibility'visible' | 'hidden'

Determines if this Tenant is visible for the enduser

created_atstring

Datum when the tenant was created in UTC format

created_bystring

ID of client that created the tenant

statusstring

internal field describing whether the user can opt-out the tenant

classstring

internal field

Example response

{
  "name": "Kivra",
  "company_id": [
    {
      "name": "Kivra AB",
      "orgnr": "SE556840226601"
    }
  ],
  "edit_security_level": 50,
  "groups": [],
  "created_at": "2019-05-20T12:42:29Z",
  "created_by": "client_15063298495eafd2749bb78e2f991af3ab023d13df",
  "status": "optional",
  "class": "opt_out"
}

Changes

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