Overview

The Teampass API permits access to a Teampass database from a third party application.

The call is performed with a GET query and sends back the data in JSON format.

This page describes how to write data.

"Note:" In this page, <valid api key> is the API key you received from your administrator.

Information about base64_enconding

Sent data is done through usage of base64 encoded data.

Nevertheless you muse ensure that the encoded data doesn't include the chatacters + and / . They need to be replace by - and _ `. This will guarantee that the URL sent is not broken by a reserved characted inside the URL.

Consequence: Please ensure that the substitution is performed inside the base64 encoded string:

  • + is replaced by -
  • / is replaced by _

Add new Item

Adding a new Item is done through URL:

<url to teampass>/api/index.php/add/item/<label>;<password>;<description>;<folder id>;<login>;<email>;<url>;<tags>;<any one can modify>?apikey=<valid api key>

<label>;<password>;<description>;<folder id>;<login>;<email>;<url>;<tags>;<any one can modify> send as a series of semicolon separated base64 encoded strings. The separator symbol is the semicolon ;. Each parameter is base64-encoded separately.

Some limitations:

  • tags field can be used for multiple tags and they need to be separated by a space.
  • any one can modify is a boolean and accepts value 1 for TRUE and value 0 for FALSE.

Notice that if a similar Label exists, the add request will fail.

The response body looks like this:

{
    "status" : "item added",
    "new_item_id" : "54"
}

Update an Item

Updating an existing Item is done through URL:

<url to teampass>/api/index.php/update/item/<item_id>/<label>;<password>;<description>;<folder_id>;<login>;<email>;<url>;<tags>;<any one can modify>?apikey=<valid api key>

With <label>;<password>;<description>;<folder id>;<login>;<email>;<url>;<tags>;<any one can modify> send as a series of semicolon separated base64 encoded strings. The separator symbol is the semicolon ;. Each parameter is base64-encoded separately.

Delete an Item

Deleting an Item is done through URL:

<url to teampass>/api/index.php/delete/item/<item_id1>;<item_id2>?apikey=<valid api key>

The separator symbol is the semicolon ;.

The response body will contain OK if the request is successful. If the request is unsuccessful, the response body will contain an error message.

Add new Folder

Adding a new Folder is done through URL:

<url to teampass>/api/index.php/add/folder/<title>;<complexity_level>;<parent_id>;<renewal_period>;<personal>?apikey=<valid api key>

With:

  • <title>;<complexity_level>;<parent_id>;<renewal_period>;<personal> send as a base64 encoding string. The separator symbol is the semicolon ;.
  • <complexity_level> is selected between the next values [0, 25, 50, 60, 70, 80, 90]
  • <personal> takes 0 if public. It takes 1 if it is a personal folder, and in this case <title> must be <user_id>.
  • <parent_id> takes 0 if it is root level.

Notice that Users will not have access to this new folder. It will be requested to set the expected access rights on it.

The answer sent back looks like this:

{
    "status" : "folder created",
    "new_folder_id" : "54"
}

Update a Folder

Updating an existing Folder is done through URL:

<url to teampass>/api/index.php/update/folder/<folder_id>/<title>;<complexity_level>;<renewal_period>?apikey=<valid api key>

With:

  • <title>;<complexity_level>;<renewal_period> send as a base64 encoding string. The separator symbol is the semicolon ;.
  • <complexity_level> is selected between the next values [0, 25, 50, 60, 70, 80, 90]

Delete a Folder

Deleting a Folder is done through URL:

<url to teampass>/api/index.php/delete/folder/<folder_id1>;<folder_id2>?apikey=<valid api key>

The separator symbol is the semicolon ;.

The response body will contain OK if the request is successful. If the request is unsuccessful, the response body will contain an error message.

Add new file attachment

Adding a new file is done by sending a POST request through URL:

<url to teampass>/api/index.php/add/file?apikey=<valid api key>

Notes: The request format must be according to RFC 2388 The Content-Type header value must be 'multipart/form-data'

You must send two data fields in the POST body: item_id : The item id to which the file will be attached file : The file data. Use parameter 'filename' to set the file name for the attachment

Example: curl -X POST "http://127.0.0.1/teampass/api/index.php/add/file?apikey=chahthait5Aidood6johh6Avufieb6ohpaixain" -F "file=@text.txt;filename=text.txt" -F "item_id=9"

POST /teampass/api/index.php/add/file/1?apikey=chahthait5Aidood6johh6Avufieb6ohpaixain HTTP/1.1
Host: 127.0.0.1
Content-Type: multipart/form-data; boundary="boundary"

--boundary
Content-Disposition: form-data; name="item_id"

9
--boundary
Content-Disposition: form-data; name="file"; filename="text.txt"
Content-Type: text/plain

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod
tempor incididunt ut labore et dolore magna aliqua.  Ut enim ad minim
veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea
commodo consequat.  Duis aute irure dolor in reprehenderit in voluptate
velit esse cillum dolore eu fugiat nulla pariatur.  Excepteur sint occaecat
cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id
est laborum

The response body looks like this:

{
    "status" : "success"
}