Partner API v1

Get the company inbox

This resource allows to access a high level description for each content in the company inbox, to allow for a first sorting and filtering of the content.

get/v1/partner/company/{companyKey}/content

Request

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

Path parameters

companyKeystring required

Company's unique key

The unique key for the company object being retrieved

Response

High level description of content items in the company inbox

keystring

Content's unique key

senderstring

Unique key for the tenant that posted the content

sender_namestring

Name of the tenant that posted the content

created_atstring

Date and time when the content was delivered to the recipient

subjectstring

Subject of the content, as set by the sender

status'read' | 'unread'

Whether the content has been read (opened) or not

Example response

[
  {
    "key": "15294092505b9cfab3f79d233f8eca6fbc5385fa61",
    "sender": "1341573157b3a133f220f4217b2e32989d2efa015",
    "sender_name": "Kivra",
    "created_at": "2018-06-19T11:54:10Z",
    "subject": "Invoice 4512 from Local Bank",
    "status": "read"
  }
]

Changes

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