Download OpenAPI specification:Download
Threema Work API is designed to let 3rd-party applications communicate with Threema Work subscriptions. *
X-API-Key
which can be obtained from your management cockpit.X-API-Key
HTTP header must be sent to indicate which API key is to be used with the request.Access to your subscription
Array of objects <application/json> (Link) [ items <application/json> ] | |
name | string Short description name of the subscription |
validUntil | string (DateTime) 24 characters *ISO8601 formated date
*Example: |
type | string Enum: "basic" "business" "enterprise" "essential" "advanced" "professional" "edu5" Chosen subscription type |
licenseAmount | integer Number of purchased licenses |
{- "_links": [
], - "name": "My Threema Work subscription",
- "validUntil": "2017-01-01T00:00:00+0100",
- "type": "professional",
- "licenseAmount": 400
}
Change the name of the subscription
name required | string [ 1 .. 256 ] characters New name of the subscription |
{- "name": "My very nice Threema Work subscription"
}
{- "message": "Detailed error message"
}
List all credentials of the package
filterUsername | string Filter the credentials by the |
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. |
Array of objects <application/json> (Link) [ items <application/json> ] | |
Array of objects (Credential) [ items ] Credential List | |
object <application/json> (Paging) |
{- "credentials": [
- {
- "id": "LAow0Rksa",
- "username": "alice",
- "password": "3mawrk",
- "licenseAmount": 0,
- "hash": false,
- "lock": true
}, - {
- "id": "pwq4Kslw",
- "username": "bob",
- "password": null,
- "licenseAmount": 0,
- "hash": true,
- "lock": false
}
], - "paging": {
- "count": 20,
- "total": 400,
- "page": 9,
}
}
Create new credentials
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 License count |
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). |
Location | string A link to the credential detail resource. |
Array of objects <application/json> (Link) [ items <application/json> ] | |
id | string (CredentialsId) Unique id of a credential record |
username | string |
password | string |
licenseAmount | integer |
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). |
{- "username": "bob",
- "password": "3mawrk",
- "hash": false,
- "licenseCount": 1,
- "lock": true
}
{- "_links": [
], - "id": "e7MCEXNCGmRDRX3BF71tJAoAiLVpvsu",
- "username": "alice",
- "password": "3mawrk",
- "licenseAmount": 1,
- "hash": true,
- "lock": true
}
Show credentials for a specified id
id required | string (CredentialsId) Example: e7MCEXNCGmRDRX3BF71tJAoAiLVpvsu Unique id of a credential record |
Array of objects <application/json> (Link) [ items <application/json> ] | |
id | string (CredentialsId) Unique id of a credential record |
username | string |
password | string |
licenseAmount | integer |
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). |
{- "_links": [
], - "id": "e7MCEXNCGmRDRX3BF71tJAoAiLVpvsu",
- "username": "alice",
- "password": "3mawrk",
- "licenseAmount": 1,
- "hash": true,
- "lock": true
}
Update the username and password of a specified id
id required | string (CredentialsId) Example: e7MCEXNCGmRDRX3BF71tJAoAiLVpvsu Unique id of a credential record |
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). |
{- "username": "bob",
- "password": "3mawrk",
- "hash": true,
- "lock": true
}
{- "message": "Detailed error message"
}
List all users of the package
filterCredential | string Filter the users by the |
filterUsername | string Filter the users by the |
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. |
Array of objects <application/json> (Link) [ items <application/json> ] | |
Array of objects (User) [ items ] User List | |
object <application/json> (Paging) |
{- "users": [
- {
- "_links": [
], - "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",
- "version": "android - 3.1k"
}, - {
- "_links": [
], - "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",
- "version": "ios - 2.9k"
}
], - "paging": {
- "count": 20,
- "total": 400,
- "page": 9,
}
}
Show a user, selected by threemaId
threemaId required | string (ThreemaId) Example: B4UXXX11 |
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. |
lastName | string Last name of the user, configured by the MDM system. |
csi | string Any value (e.g. internal username), configured by the MDM system. |
category | string User category (e.g. group, department), configured by the MDM system. |
version | string Used Version *
|
lastCheck | string (DateTime) 24 characters *ISO8601 formated date
*Example: |
createdAt | string (DateTime) 24 characters *ISO8601 formated date
*Example: |
{- "_links": [
], - "id": "B4UXXX11",
- "nickname": "Alice",
- "firstName": "Al",
- "lastName": "Ice",
- "csi": "AI000001",
- "category": "Marketing",
- "version": "android - 3.1k",
- "lastCheck": "2017-01-01T00:00:00+0100",
- "createdAt": "2017-01-01T00:00:00+0100"
}