API projects

Version 1.1

Search my projects

Search and return the list of projects that the (authenticated) user is a member of. This includes the projects created by the user, and the projects as an invitee. When no search parameter is given, all projects are returned.

Endpoint /-api/projects/v1/search-my-projects
Method GET
Output JSON
Paginated Yes
Input Parameters
Name Default Example Description
s ”” “reports” If the parameter is not given or otherwise it’s the empty string, all your projects are returned. Otherwise, the given search parameter is matched against your project names, descriptions, or project members usernames.
p 0 7 Page number (0 indexed) of the search results to fetch.
Projects Search: Output JSON Format
{
  "version": "String: this format's version; e.g. 1.1.0",
  "search": "String: search parameter. Can be null if no search given.",
  "totalFound": "Number: total number of projects that match the search",
  "pages": {
    //the search is paginated
    "current": "Number: paginated search's current page",
    "previous": "Number: paginated search's previous page; -1 if current page == 0",
    "next": "Number: paginated search's current page; -1 if current page is the last page",
    "numPages": "Number: total number of pages in the search. If numPages <= 1, the current page contains all found results"
    "pageSize": "Number: page size"
  }
  "projectsPage": [
    //current page's array of found projects. This page may or may not contain all results
    {
      "name": "String: project's name; e.g. yourProjectName",
      "owner": "String: project's owner (username); e.g. yourUsername",
      "description": "String: project's description",
      "created": "String: creation date; e.g. 2019-08-05",
      "isPublic": "Boolean: true if this project is public; false otherwise",
      "numDocuments": "Number: total number of documents in this project",
      "url": "String: URL to this project (relative to tagtog's domain)",
      "members": [
        //array of project members. The project owner is always returned (with role admin)
        {
          "username": "String: members username invited to this project",
          "role": "String: member's role; string value in {reader, supercurator, admin}"
        },
        //... next members if any
      ]
    },
    //... next projects in this page if any
  ]
}

GET list of my projects

⚠️ DEPRECATED 2019-10-11 – Will be removed after 2020-01-11

👉 Use instead: search-my-projects

Return the list of projects that the (authenticated) user is a member of. This includes the projects created by the user, and the projects as an invitee.

Endpoint /-api/projects/v1/my_projects
Method GET
Output JSON
Input Parameters

None

Coding examples
curl -u yourUsername:yourPassword https://www.tagtog.net/-api/projects/v1/my_projects