Threema Work API

Threema Work API (1.3.1)

Download OpenAPI specification:Download

Threema Work API is designed to let 3rd-party applications communicate with Threema Work subscriptions. *

  • All requests are authenticated using an X-API-Key which can be obtained from your management cockpit.
  • An X-API-Key HTTP header must be sent to indicate which API key is to be used with the request.
  • The API key must match the remote IP (if specified for the given API key) of the connected HTTP client.

Authentication

apiKey

Security Scheme Type API Key
Header parameter name: X-Api-Key

Subscription

Subscription methods provide access to the subscription.

Subscription: Detail

Access to your subscription

Authorizations:

Responses

Response Schema: application/json
Array of objects <application/json> (Link)
name
string

Short description name of the subscription

validUntil
string

Period of validity of the subscription * *Format: iso8601 *Example: 2018-02-28T22:20:04+0100

type
string
Enum: "basic" "business" "enterprise"

Chosen subscription type

licenseAmount
integer

Number of purchased licenses

Response samples

Content type
application/json
{}

Subscription: Update

Change the name of the subscription

Authorizations:
Request Body schema: application/json
name
required
string [ 1 .. 256 ] characters

New name of the subscription

Responses

Request samples

Content type
application/json
{
  • "name": "My very nice Threema Work subscription"
}

Response samples

Content type
application/json
{
  • "message": "Detailed error message"
}

Credentials

Credential methods provide access to the subscription credentials.

Credentials: List

List all credentials of the package

Authorizations:
query Parameters
pageSize
integer

Set to limit the filter result. (0 will ignore the limit and return ALL records)

page
integer

Set to page offset the filter result to a particular record count.

Responses

Response Schema: application/json
Array of objects <application/json> (Link)
Array of objects (Credential)

Credential List

paging
object

Response samples

Content type
application/json
{}

Credentials: Create

Create new credentials

Authorizations:
Request Body schema: application/json
username
required
string [ 1 .. 256 ] characters

Unique username

password
required
string [ 1 .. 256 ] characters

Password of the credential

licenseCount
integer

License count

Responses

Request samples

Content type
application/json
{
  • "username": "bob",
  • "password": "3mawrk",
  • "licenseCount": "2"
}

Response samples

Content type
application/json
{
  • "message": "Detailed error message"
}

Credentials: Detail

Show credentials for a specified id

Authorizations:
path Parameters
id
required
string

Responses

Response Schema: application/json
Array of objects <application/json> (Link)
id
string
username
string
password
string
licenseAmount
integer

Response samples

Content type
application/json
{