Threema Work API (1.8.1)

Download OpenAPI specification:

E-mail: support-work@threema.ch

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.
Requests must be limited to 10,000 per day, the server will return HTTP header code 429 if the request limit is reached.
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.

Subscription

Subscription methods provide access to the subscription.

Subscription: Detail

Access to your subscription

Authorizations:

apiKey

Responses

Response Schema: application/json

	Array of objects <application/json> (Link) [ items <application/json > ]
id	string = 10 characters Unique subscription identifier
name	string Short description name of the subscription
validUntil	string (DateTime) = 24 characters ISO8601 formated date Example: `2017-01-01T00:00:00+0100`
type	string Enum: "basic" "business" "enterprise" "essential" "advanced" "professional" "edu5" "professional_25" "basic_25" Chosen subscription type
licenseAmount	integer Number of purchased licenses

Response samples

200
401

Content type

application/json

{"_links": [{"ref": "detail",
"link": "https://work.threema.ch/api/v1"
},
{"ref": "credentials",
"link": "https://work.threema.ch/api/v1/credentials"
},
{"ref": "users",
"link": "https://work.threema.ch/api/v1/users"
},
{"ref": "contacts",
"link": "https://work.threema.ch/api/v1/contacts"
}
],
"id": "XYZ0123456",
"name": "My Threema Work subscription",
"validUntil": "2017-01-01T00:00:00+0100",
"type": "professional",
"licenseAmount": 400
}

Subscription: Update

Change the name of the subscription

Authorizations:

apiKey

Request Body schema: application/json
required

name

required

string [ 1 .. 256 ] characters

New name of the subscription

Responses

Request samples

Payload

Content type

application/json

{"name": "My very nice Threema Work subscription"
}

Response samples

400
401

Content type

application/json

{"error": "Detailed error message"
}

Credentials

Credential methods provide access to the subscription credentials.

Credentials: List

List all credentials of the package

Authorizations:

apiKey

query Parameters

filterUsername	string Filter the credentials by the `username`
pageSize	integer <int32> (PageSizeParameter) [ 1 .. 5000 ] Default: 20 Set the limit the filter result.
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) [ items <application/json > ]
	Array of objects (Credential) Credential List
	object <application/json> (Paging)

Response samples

200
401

Content type

application/json

{"_links": [{"ref": "subscription",
"link": "https://work.threema.ch/api/v1"
}
],
"credentials": [{"_links": [{"ref": "detail",
"link": "https://work.threema.ch/api/v1/credentials/LAow0Rksa"
}
],
"id": "LAow0Rksa",
"username": "alice",
"password": "3mawrk",
"usage": 0,
"hashed": false,
"locked": true
},
{"_links": [{"ref": "detail",
"link": "https://work.threema.ch/api/v1/credentials/pwq4Kslw"
}
],
"id": "pwq4Kslw",
"username": "bob",
"password": null,
"usage": 0,
"hashed": true,
"locked": false
}
],
"paging": {"count": 20,
"total": 400,
"page": 9,
"_links": [{"ref": "detail",
"link": "https://work.threema.ch/api/v1/link-to-resource"
}
]
}
}

Credentials: Create

Create new credentials

Authorizations:

apiKey

Request Body schema: application/json
required

username required	string [ 1 .. 256 ] characters Unique username
password required	string [ 1 .. 256 ] characters Password of the credential
hash	boolean Default: false If you save the password as hash, there’s no way for you to retrieve it.
licenseCount	integer Amount of ID creations allowed for the credentital. Only set to more then 1 if credential should be a multi-user license.
lock	boolean Once the credentials are in use with a specific ID, they cannot be used in conjunction with any other ID (unless the original ID is either revoked or detached from this subscription).
	(LicenseReceiverAddress (string or null)) Default: null Receiver E-Mail address for the activation link
invite	boolean Default: true Sent E-Mail invite to address, if address is given and valid
language	string (LicenseReceiverLanguage) Enum: "en" "de" "es" Language for the activation link e-mail content

Responses

Response Headers
Location	string A link to the credential detail resource.

Response Schema: application/json

	Array of objects <application/json> (Link) [ items <application/json > ]
id	string (CredentialsId) Unique id of a credential record
username	string
password	string
usage	integer
hashed	boolean Default: false If you save the password as hash, there’s no way for you to retrieve it.
locked	boolean Once the credentials are in use with a specific ID, they cannot be used in conjunction with any other ID (unless the original ID is either revoked or detached from this subscription).

Request samples

Payload

Content type

application/json

{"username": "bob",
"password": "3mawrk",
"hash": false,
"licenseCount": 1,
"lock": true,
"address": "work@threema.ch",
"invite": true,
"language": "en"
}

Response samples

201
400
401
403

Content type

application/json

{"_links": [{"ref": "detail",
"link": "https://work.threema.ch/api/v1/credentials/LAow0Rksa"
},
{"ref": "subscription",
"link": "https://work.threema.ch/api/v1"
}
],
"id": "e7MCEXNCGmRDRX3BF71tJAoAiLVpvsu",
"username": "alice",
"password": "3mawrk",
"usage": 1,
"hashed": true,
"locked": true
}

CredentialReceiver: Resend All

Resend to all possible license receivers

Authorizations:

apiKey

Request Body schema: application/json
required

language

required

string (LicenseReceiverLanguage)

Enum: "en" "de" "es"

Language for the activation link e-mail content

Responses

Response Schema: application/json

invited_count

integer

Request samples

Payload

Content type

application/json

{"language": "en"
}

Response samples

200
400
401

Content type

application/json

{"invited_count": "Count of sent invitations"
}

Credentials: Detail

Show credentials for a specified id

Authorizations:

apiKey

path Parameters

id

required

string (CredentialsId)

Example: e7MCEXNCGmRDRX3BF71tJAoAiLVpvsu

Unique id of a credential record

Responses

Response Schema: application/json

	Array of objects <application/json> (Link) [ items <application/json > ]
id	string (CredentialsId) Unique id of a credential record
username	string
password	string
usage	integer
hashed	boolean Default: false If you save the password as hash, there’s no way for you to retrieve it.
locked	boolean Once the credentials are in use with a specific ID, they cannot be used in conjunction with any other ID (unless the original ID is either revoked or detached from this subscription).

Response samples

200
400
401
404

Content type

application/json

{"_links": [{"ref": "detail",
"link": "https://work.threema.ch/api/v1/credentials/LAow0Rksa"
},
{"ref": "subscription",
"link": "https://work.threema.ch/api/v1"
}
],
"id": "e7MCEXNCGmRDRX3BF71tJAoAiLVpvsu",
"username": "alice",
"password": "3mawrk",
"usage": 1,
"hashed": true,
"locked": true
}

Credentials: Update

Update the username and password of a specified id

Authorizations:

apiKey

path Parameters

id

required

string (CredentialsId)

Example: e7MCEXNCGmRDRX3BF71tJAoAiLVpvsu

Unique id of a credential record

Request Body schema: application/json
required

username required	string [ 1 .. 256 ] characters Unique username
password required	string [ 1 .. 256 ] characters Password of the credential
hash	boolean Default: false If you save the password as hash, there’s no way for you to retrieve it.
lock	boolean Once the credentials are in use with a specific ID, they cannot be used in conjunction with any other ID (unless the original ID is either revoked or detached from this subscription).

Responses

Request samples

Payload

Content type

application/json

{"username": "bob",
"password": "3mawrk",
"hash": true,
"lock": true
}

Response samples

400
401
404

Content type

application/json

{"error": "Detailed error message"
}

Credentials: Remove

Remove credentials of a specified id

Authorizations:

apiKey

path Parameters

id

required

string (CredentialsId)

Example: e7MCEXNCGmRDRX3BF71tJAoAiLVpvsu

Unique id of a credential record

Responses

Response samples

400
401
404

Content type

application/json

{"error": "Detailed error message"
}

CredentialsReceiver: Detail

Show credentials receiver for a specified id

Authorizations:

apiKey

path Parameters

id

required

string (CredentialsId)

Example: e7MCEXNCGmRDRX3BF71tJAoAiLVpvsu

Unique id of a credential record

Responses

Response Schema: application/json

	Array of objects <application/json> (Link) [ items <application/json > ]
type	string Value: "email" Receiver address type
address	string <email> (LicenseReceiverAddress) Receiver e-mail address for the activation link
state	string or null Enum: "processing" "sent" "failed" State of the current seding process
sentCount	integer or null Sending counter
	(DateTime (string or null))

Response samples

200
400
401
404

Content type

application/json

{"_links": [{"ref": "detail",
"link": "https://work.threema.ch/api/v1credentials/ID/receiver"
},
{"ref": "credential",
"link": "https://work.threema.ch/api/v1/credentials(ID"
}
],
"type": "email",
"address": "work@threema.ch",
"state": "sent",
"sentCount": 3,
"lastSent": "2017-01-01T00:00:00+0100"
}

CredentialReceiver: Update

Update the existing license receiver of specified id

Authorizations:

apiKey

path Parameters

id

required

string (CredentialsId)

Example: e7MCEXNCGmRDRX3BF71tJAoAiLVpvsu

Unique id of a credential record

Request Body schema: application/json
required

address

required

string <email> (LicenseReceiverAddress)

Receiver e-mail address for the activation link

Responses

Request samples

Payload

Content type

application/json

{"address": "work@threema.ch"
}

Response samples

400
401
404

Content type

application/json

{"error": "Detailed error message"
}

CredentialReceiver: Remove

Remove credentials receiver of a specified id

Authorizations:

apiKey

path Parameters

id

required

string (CredentialsId)

Example: e7MCEXNCGmRDRX3BF71tJAoAiLVpvsu

Unique id of a credential record

Responses

Response samples

400
401
404

Content type

application/json

{"error": "Detailed error message"
}

CredentialReceiver: Resend

Resend the license to the receiver of specified id

Authorizations:

apiKey

path Parameters

id

required

string (CredentialsId)

Example: e7MCEXNCGmRDRX3BF71tJAoAiLVpvsu

Unique id of a credential record

Request Body schema: application/json
required

language

required

string (LicenseReceiverLanguage)

Enum: "en" "de" "es"

Language for the activation link e-mail content

Responses

Request samples

Payload

Content type

application/json

{"language": "en"
}

Response samples

400
401
404
429

Content type

application/json

{"error": "Detailed error message"
}

Users

Subscription methods provide access to the subscription users.

Users: List

List all users of the package

Authorizations:

apiKey

query Parameters

filterCredential	string Filter the users by the `id` of the used `Credential`
filterUsername	string Filter the users by the `username` of the used `Credential`
filterQuery	string Search the users
pageSize	integer <int32> (PageSizeParameter) [ 1 .. 5000 ] Default: 20 Set the limit the filter result.
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) [ items <application/json > ]
	Array of objects (User) User List
	object <application/json> (Paging)

Response samples

200
400
401

Content type

application/json

{"_links": [{"ref": "subscription",
"link": "https://work.threema.ch/api/v1"
}
],
"users": [{"_links": [{"link": "https://work.threema.ch/api/v1/users/USER001",
"ref": "detail"
},
{"link": "https://work.threema.ch/api/v1/credentials/LAow0Rksa",
"ref": "credential"
}
],
"id": "USER001",
"lastCheck": "2021-12-01T00:00:00+0100",
"createdAt": "2017-01-01T00:00:00+0100",
"nickname": "Alice",
"firstName": "Al",
"lastName": "Ice",
"csi": "AI000001",
"category": "marketing,employees",
"jobTitle": "Marketing Manager",
"department": "Marketing",
"version": "android - 3.1k"
},
{"_links": [{"link": "https://work.threema.ch/api/v1/users/USER002",
"ref": "detail"
},
{"link": "https://work.threema.ch/api/v1/credentials/Kpsow3lSdf",
"ref": "credential"
}
],
"id": "USER002",
"lastCheck": "2021-12-01T00:00:00+0100",
"createdAt": "2017-01-01T00:00:00+0100",
"nickname": "Bob",
"firstName": "B",
"lastName": "Ob",
"csi": "AI000002",
"category": "it,employees",
"jobTitle": "Software Engineer",
"department": "IT",
"version": "ios - 2.9k"
}
],
"paging": {"count": 20,
"total": 400,
"page": 9,
"_links": [{"ref": "detail",
"link": "https://work.threema.ch/api/v1/link-to-resource"
}
]
}
}

User: Detail

Show a user, selected by threemaId

Authorizations:

apiKey

path Parameters

threemaId

required

string (ThreemaId)

Example: B4UXXX11

Responses

Response Schema: application/json

	Array of objects <application/json> (Link) [ items <application/json > ]
id	string (ThreemaId)
nickname	string Nickname, chosen by the user in the Threema App
firstName	string First name of the user, configured by the MDM system or app configuration.
lastName	string Last name of the user, configured by the MDM system or app configuration.
csi	string Any value (e.g. internal username), configured by the MDM system or app configuration.
category	string User category (e.g. group, team, location), configured by the MDM system or app configuration.
jobTitle	string Job title of the user, configured by the MDM system or app configuration.
department	string Department of the user, configured by the MDM system or app configuration.
version	string Used Version * Example: `android - 3.1k` \| OS \| Separator \| App Version \| \|---------\|-----------\|-------------\| \| `android` \| `-` \| `3.1k` \|
lastCheck	string (DateTime) = 24 characters ISO8601 formated date Example: `2017-01-01T00:00:00+0100`
createdAt	string (DateTime) = 24 characters ISO8601 formated date Example: `2017-01-01T00:00:00+0100`

Response samples

200
400
401
404

Content type

application/json

{"_links": [{"ref": "detail",
"link": "https://work.threema.ch/api/v1/users/ECHOECHO"
},
{"ref": "subscription",
"link": "https://work.threema.ch/api/v1"
},
{"ref": "credential",
"link": "https://work.threema.ch/api/v1/credentials/LAow0Rksa"
}
],
"id": "B4UXXX11",
"nickname": "Alice",
"firstName": "Al",
"lastName": "Ice",
"csi": "AI000001",
"category": "marketing,employees",
"jobTitle": "Manager",
"department": "Marketing",
"version": "android - 3.1k",
"lastCheck": "2017-01-01T00:00:00+0100",
"createdAt": "2017-01-01T00:00:00+0100"
}

User: Remove

Revoke a user(Threema ID), selected by threemaId

Authorizations:

apiKey

path Parameters

threemaId

required

string (ThreemaId)

Example: B4UXXX11

Responses

Response samples

400
401
404

Content type

application/json

{"error": "Detailed error message"
}

User: Unlink

Detach a user (Threema ID) from subscription

Authorizations:

apiKey

path Parameters

threemaId

required

string (ThreemaId)

Example: B4UXXX11

Responses

Response samples

400
401
404

Content type

application/json

{"error": "Detailed error message"
}

Contacts

Contact Categories: Show

Show a contact category (Directory Feature required)

Authorizations:

apiKey

path Parameters

threemaId

required

string (ThreemaId)

Example: B4UXXX11

Responses

Response samples

401

Content type

application/json

{"error": "Detailed error message"
}

Contact: List

List custom contacts of your subscription

Authorizations:

apiKey

query Parameters

filterCategory	string Filter the result by the category
pageSize	integer <int32> (PageSizeParameter) [ 1 .. 5000 ] Default: 20 Set the limit the filter result.
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) [ items <application/json > ]
	Array of objects (Contact) Contact List
	object <application/json> (Paging)

Response samples

200
401

Content type

application/json

{"_links": [{"ref": "subscription",
"link": "https://work.threema.ch/api/v1"
}
],
"contacts": [{"_links": [{"ref": "detail",
"link": "https://work.threema.ch/api/v1/contacts/*THREEMA"
},
{"ref": "detail",
"link": "https://work.threema.ch/api/v1/contacts/*THREEMA/categories"
}
],
"id": "*THREEMA",
"type": "custom",
"firstName": "Threema",
"lastName": "Channel",
"enabled": false
},
{"_links": [{"ref": "detail",
"link": "https://work.threema.ch/api/v1/contacts/ECHOECHO"
},
{"ref": "detail",
"link": "https://work.threema.ch/api/v1/contacts/ECHOECHO/categories"
}
],
"id": "ECHOECHO",
"type": "auto",
"firstName": "Echo",
"lastName": "Ohce",
"enabled": true
}
],
"paging": {"count": 20,
"total": 400,
"page": 9,
"_links": [{"ref": "detail",
"link": "https://work.threema.ch/api/v1/link-to-resource"
}
]
}
}

Contact: Create

Create a new custom contact

Authorizations:

apiKey

Request Body schema: application/json
required

threemaId required	string (ThreemaId)
firstName	string [ 1 .. 256 ] characters
lastName	string [ 1 .. 256 ] characters
enabled	boolean
directory_enabled	boolean

Responses

Response Headers
Location	string A link to the contact detail resource.

Request samples

Payload

Content type

application/json

{"threemaId": "B4UXXX11",
"firstName": "Echo",
"lastName": "Ohce",
"enabled": true,
"directory_enabled": true
}

Response samples

400
401

Content type

application/json

{"error": "Detailed error message"
}

Contact: Detail

Show a contact, selected by threemaId

Authorizations:

apiKey

path Parameters

threemaId

required

string (ThreemaId)

Example: B4UXXX11

Responses

Response Schema: application/json

	Array of objects <application/json> (Link) [ items <application/json > ]
threemaId	string (ThreemaId)
type	string Enum: "custom" "auto"
firstName	string
lastName	string
enabled	boolean
directory_enabled	boolean or null

Response samples

200
400
401
404

Content type

application/json

{"_links": [{"ref": "detail",
"link": "https://work.threema.ch/api/v1/contacts/ECHOECHO"
},
{"ref": "categories",
"link": "https://work.threema.ch/api/v1/contacts/ECHOECHO/categories"
},
{"ref": "subscription",
"link": "https://work.threema.ch/api/v1"
}
],
"threemaId": "B4UXXX11",
"type": "auto",
"firstName": "Echo",
"lastName": "Ohce",
"enabled": true,
"directory_enabled": true
}

Contact: Update

Change the information of a contact, selected by threemaId

Authorizations:

apiKey

path Parameters

threemaId

required

string (ThreemaId)

Example: B4UXXX11

Request Body schema: application/json
required

firstName required	string [ 1 .. 256 ] characters
lastName required	string [ 1 .. 256 ] characters
enabled required	boolean
directory_enabled	boolean

Responses

Request samples

Payload

Content type

application/json

{"firstName": "Echo",
"lastName": "Ohce",
"enabled": true,
"directory_enabled": true
}

Response samples

400
401
404

Content type

application/json

{"error": "Detailed error message"
}

Contact: Remove

Revoke a custom contact, selected by threemaId

Authorizations:

apiKey

path Parameters

threemaId

required

string (ThreemaId)

Example: B4UXXX11

Responses

Response samples

400
401
404

Content type

application/json

{"error": "Detailed error message"
}

Contact Categories: List

List the categories of the given contact (Directory Feature required)

Authorizations:

apiKey

path Parameters

threemaId

required

string (ThreemaId)

Example: B4UXXX11

query Parameters

pageSize	integer <int32> (PageSizeParameter) [ 1 .. 5000 ] Default: 20 Set the limit the filter result.
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) [ items <application/json > ]
	Array of objects (Category) Categories
	object <application/json> (Paging)

Response samples

200
401

Content type

application/json

{"_links": [{"ref": "contact",
"link": "https://work.threema.ch/api/v1/contacts/ECHOECHO"
}
],
"categories": [{"_links": [{"ref": "detail",
"link": "https://work.threema.ch/api/v1/category/yyyyyyyyyy"
}
],
"id": "yyyyyyyyyy",
"name": "Category 1 by MDM",
"source": "mdm"
},
{"_links": [{"ref": "detail",
"link": "https://work.threema.ch/api/v1/category/xxxxxxxxx"
}
],
"id": "xxxxxxxxx",
"name": "Category 2",
"source": "custom"
}
],
"paging": {"count": 20,
"total": 400,
"page": 9,
"_links": [{"ref": "detail",
"link": "https://work.threema.ch/api/v1/link-to-resource"
}
]
}
}

App Configuration

Individual App Configuration: List

Show all individual settings of a credential

Authorizations:

apiKey

path Parameters

id

required

string (CredentialsId)

Example: e7MCEXNCGmRDRX3BF71tJAoAiLVpvsu

Unique id of a credential record

Responses

Response Schema: application/json

	Array of objects <application/json> (Link) [ items <application/json > ]
	Array of objects (MdmObject) List of settings (for the specific credentials)

Response samples

200
401

Content type

application/json

{"_links": [{"ref": "detail",
"link": "https://work.threema.ch/api/v1/credentials/LAow0Rksa/mdm"
},
{"ref": "credential",
"link": "https://work.threema.ch/api/v1/credentials/LAow0Rksa"
}
],
"parameters": [{"_links": [{"link": "https://work.threema.ch/api/v1/credentials/LAow0Rksa/mdm/th_disable_screenshots",
"ref": "detail"
}
],
"name": "th_disable_screenshots",
"value": true
},
{"_links": [{"link": "https://work.threema.ch/api/v1/credentials/LAow0Rksa/mdm/th_nickname",
"ref": "detail"
}
],
"name": "th_nickname",
"value": "J.W."
}
]
}

Individual App Configuration: Create

Create or modify an individual setting of a credential

Authorizations:

apiKey

path Parameters

id

required

string (CredentialsId)

Example: e7MCEXNCGmRDRX3BF71tJAoAiLVpvsu

Unique id of a credential record

Request Body schema: application/json
required

property required	string (MdmProperty) [ 4 .. 256 ] characters Setting name (starting with `th_`)
required	string or integer or boolean (MdmValue) Value of the property

Responses

Request samples

Payload

Content type

application/json

{"property": "th_firstname",
"value": "Peter Schreiner"
}

Response samples

400
401

Content type

application/json

{"error": "Detailed error message"
}

Individual App Configuration: Show

Show a setting (setting selected by the property_id) of a credential record (selected by the id). The property_id is the unique name of a setting.

Authorizations:

apiKey

path Parameters

id required	string (CredentialsId) Example: e7MCEXNCGmRDRX3BF71tJAoAiLVpvsu Unique id of a credential record
property_id required	string (MdmProperty) [ 4 .. 256 ] characters Example: th_firstname Setting name (starting with `th_`)

Responses

Response Schema: application/json

	Array of objects <application/json> (Link) [ items <application/json > ]
name	string (MdmProperty) [ 4 .. 256 ] characters Setting name (starting with `th_`)
	string or integer or boolean (MdmValue) Value of the property

Response samples

200
400
401
404

Content type

application/json

{"_links": [{"ref": "detail",
"link": "https://work.threema.ch/api/v1/credentials/LAow0Rksa/mdm/th_disable_screenshots"
},
{"ref": "credential",
"link": "https://work.threema.ch/api/v1/credentials/LAow0Rksa"
}
],
"name": "th_firstname",
"value": "Peter Schreiner"
}

Individual App Configuration: Update

Update a individual setting of a credential record (selected by the id field}

Authorizations:

apiKey

path Parameters

id required	string (CredentialsId) Example: e7MCEXNCGmRDRX3BF71tJAoAiLVpvsu Unique id of a credential record
property_id required	string (MdmProperty) [ 4 .. 256 ] characters Example: th_firstname Setting name (starting with `th_`)

Responses

Response Schema: application/json

	Array of objects <application/json> (Link) [ items <application/json > ]
name	string (MdmProperty) [ 4 .. 256 ] characters Setting name (starting with `th_`)
	string or integer or boolean (MdmValue) Value of the property

Response samples

200
400
401
404

Content type

application/json

{"_links": [{"ref": "detail",
"link": "https://work.threema.ch/api/v1/link-to-resource"
}
],
"name": "th_firstname",
"value": "Peter Schreiner"
}

Individual App Configuration: Remove

Remove an individual setting value (selected by property_id) of a credential (selected by id)

Authorizations:

apiKey

path Parameters

id required	string (CredentialsId) Example: e7MCEXNCGmRDRX3BF71tJAoAiLVpvsu Unique id of a credential record
property_id required	string (MdmProperty) [ 4 .. 256 ] characters Example: th_firstname Setting name (starting with `th_`)

Responses

Response samples

400
401
404

Content type

application/json

{"error": "Detailed error message"
}

Global App Configuration: List

Show all global settings of a subscription

Authorizations:

apiKey

Responses

Response Schema: application/json

	Array of objects <application/json> (Link) [ items <application/json > ]
	Array of objects (SubscriptionMdmProperty) List of settings

Response samples

200
401

Content type

application/json

{"_links": [{"ref": "subscription",
"link": "https://work.threema.ch/api/v1"
}
],
"parameters": [{"_links": [{"link": "https://work.threema.ch/api/v1/mdm/th_disable_screenshots",
"ref": "detail"
},
{"link": "https://work.threema.ch/api/v1",
"ref": "subscription"
}
],
"name": "th_disable_screenshots",
"value": true
},
{"_links": [{"link": "https://work.threema.ch/api/v1/mdm/th_nickname",
"ref": "detail"
},
{"link": "https://work.threema.ch/api/v1",
"ref": "subscription"
}
],
"name": "th_nickname",
"value": "J.W."
}
]
}

Global App Configuration: Create

Create or modify a global setting of a subscription

Authorizations:

apiKey

Request Body schema: application/json
required

property required	string (MdmProperty) [ 4 .. 256 ] characters Setting name (starting with `th_`)
required	string or integer or boolean (MdmValue) Value of the property

Responses

Request samples

Payload

Content type

application/json

{"property": "th_firstname",
"value": "Peter Schreiner"
}

Response samples

400
401

Content type

application/json

{"error": "Detailed error message"
}

Individual App Configuration: Bulk Get

Show all app configuration settings for each credential

Authorizations:

apiKey

query Parameters

pageSize	integer <int32> (PageSizeParameterSmall) [ 1 .. 500 ] Default: 20 Set the limit the filter result.
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) [ items <application/json > ]
	Array of objects (CredentialMdmParameters) Array of credentials with individual app configuration settings
	object <application/json> (Paging)

Response samples

200
401

Content type

application/json

{"_links": [{"ref": "subscription",
"link": "https://work.threema.ch/api/v1"
}
],
"credentials": [[{"_links": [{"rel": "detail",
"link": "https://work.threema.ch/api/v1/credentials/LAow0Rksa/mdm"
},
{"rel": "credential",
"link": "https://work.threema.ch/api/v1/credentials/LAow0Rksa"
}
],
"id": "LAow0Rksa",
"parameters": [{"_links": [{"rel": "detail",
"link": "https://work.threema.ch/api/v1/credentials/s3dEi7gcaphALd1/mdm/th_disable_screenshots"
}
],
"name": "th_disable_screenshots",
"value": true
},
{"_links": [{"rel": "detail",
"link": "https://work.threema.ch/api/v1/credentials/s3dEi7gcaphALd2/mdm/th_nickname"
}
],
"name": "th_nickname",
"value": "Alice"
}
]
},
{"_links": [{"rel": "detail",
"link": "https://work.threema.ch/api/v1/credentials/LAow0Rksa2/mdm"
},
{"rel": "credential",
"link": "https://work.threema.ch/api/v1/credentials/LAow0Rksa2"
}
],
"id": "LAow0Rksa2",
"parameters": [{"_links": [{"rel": "detail",
"link": "https://work.threema.ch/api/v1/credentials/s3dEi7gcaphF0DK1/mdm/th_disable_screenshots"
}
],
"name": "th_disable_screenshots",
"value": true
},
{"_links": [{"rel": "detail",
"link": "https://work.threema.ch/api/v1/credentials/s3dEi7gcaphF0DK2/mdm/th_nickname"
}
],
"name": "th_nickname",
"value": "Alice"
}
]
}
]
],
"paging": {"count": 20,
"total": 400,
"page": 9,
"_links": [{"ref": "detail",
"link": "https://work.threema.ch/api/v1/link-to-resource"
}
]
}
}

Individual App Configuration: Bulk Update

Create or modify multiple settings at once

Authorizations:

apiKey

Request Body schema: application/json
required

Array of objects (CredentialMdmParameters) <= 1000 items

Array of credentials with individual app configuration settings

Responses

Request samples

Payload

Content type

application/json

{"credentials": [{"id": "LAow0Rksa",
"parameters": [{"name": "th_disable_screenshots",
"value": true
},
{"name": "th_nickname",
"value": "Alice"
}
]
},
{"id": "LAow0Rksa2",
"parameters": [{"name": "th_disable_screenshots",
"value": true
},
{"name": "th_nickname",
"value": "Alice"
}
]
}
]
}

Response samples

400
401

Content type

application/json

{"error": "Detailed error message"
}

Global App Configuration: Show

Load a global setting (selected by property_id) of a subscription. The property_id is the unique name of a setting.

Authorizations:

apiKey

path Parameters

property_id

required

string (MdmProperty) [ 4 .. 256 ] characters

Example: th_firstname

Setting name (starting with th_)

Responses

Response Schema: application/json

	Array of objects <application/json> (Link) [ items <application/json > ]
id	string (MdmProperty) [ 4 .. 256 ] characters Setting name (starting with `th_`)
	string or integer or boolean (MdmValue) Value of the property

Response samples

200
400
401
404

Content type

application/json

{"_links": [{"ref": "detail",
"link": "https://work.threema.ch/api/v1/mdm/th_disable_screenshots"
},
{"ref": "subscription",
"link": "https://work.threema.ch/api/v1"
}
],
"id": "th_firstname",
"value": "Peter Schreiner"
}

Global App Configuration: Update

Update a global setting of a subscription

Authorizations:

apiKey

path Parameters

property_id

required

string (MdmProperty) [ 4 .. 256 ] characters

Example: th_firstname

Setting name (starting with th_)

Responses

Response Schema: application/json

	Array of objects <application/json> (Link) [ items <application/json > ]
name	string (MdmProperty) [ 4 .. 256 ] characters Setting name (starting with `th_`)
	string or integer or boolean (MdmValue) Value of the property

Response samples

200
400
401
404

Content type

application/json

{"_links": [{"ref": "detail",
"link": "https://work.threema.ch/api/v1/link-to-resource"
}
],
"name": "th_firstname",
"value": "Peter Schreiner"
}

Global App Configuration: Remove

Remove a global setting of a subscription, selected by property_id

Authorizations:

apiKey

path Parameters

property_id

required

string (MdmProperty) [ 4 .. 256 ] characters

Example: th_firstname

Setting name (starting with th_)

Responses

Response samples

400
401
404

Content type

application/json

{"error": "Detailed error message"
}

Logos

Logo Variant: Show

Access to your in-app logos

Authorizations:

apiKey

path Parameters

logoVariant

required

string (LogoVariant)

Enum: "dark" "light"

Example: dark

Responses

Response Schema: image/png

string <binary> (Binary)

PNG-image file with a resolution of at least 680 × 80 pixels.

Response samples

401
404

Content type

application/json

{"error": "Detailed error message"
}

Logo Variant: Update

Update the subscription’s in-app logo by variant (light,dark)

Authorizations:

apiKey

path Parameters

logoVariant

required

string (LogoVariant)

Enum: "dark" "light"

Example: dark

Request Body schema: image/png
required

string <binary> (Binary)

PNG-image file with a resolution of at least 680 × 80 pixels.

Responses

Response samples

400
401

Content type

application/json

{"error": "Detailed error message"
}

Logo Variant: Delete

Delete the subscription’s in-app logos by variant (light,dark)

Authorizations:

apiKey

path Parameters

logoVariant

required

string (LogoVariant)

Enum: "dark" "light"

Example: dark

Responses

Response samples

400
401
404

Content type

application/json

{"error": "Detailed error message"
}

Threema Work API (1.8.1)

Subscription

Subscription: Detail

Authorizations:

Responses

Response Schema: application/json

Response samples

Subscription: Update

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Credentials

Credentials: List

Authorizations:

query Parameters

Responses

Response Schema: application/json

Response samples

Credentials: Create

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

CredentialReceiver: Resend All

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Credentials: Detail

Authorizations:

path Parameters

Responses

Response Schema: application/json

Response samples

Credentials: Update

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Credentials: Remove

Authorizations:

path Parameters

Responses

Response samples

CredentialsReceiver: Detail

Authorizations:

path Parameters

Responses

Response Schema: application/json

Response samples

CredentialReceiver: Update

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

CredentialReceiver: Remove

Authorizations:

path Parameters

Responses

Response samples

CredentialReceiver: Resend

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Users

Users: List

Authorizations:

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required