Gtdagenda.com API

The Gtdagenda API is implemented as a PHP page that accepts GET or POST requests and returns JSON or XML.

API clients must hit the URL http://app.gtdagenda.com/api2.php

All API requests must have a key argument indicating the user, except cmd=login.

CREATING


Methods

MethodExpected parameters

logoUpload

logo (type: data, POST file data)

userInvite

firstname (type: string, required: Yes, User First Name)
lastname (type: string, User Last Name)
email (type: string, required: Yes, User Email)
message (type: string, Optional message)
admin (type: boolean, User will be Admin, 1 or 0, default: 0)
invitekey (type: string, If valid, existing invite will be resent)

groupCreate

name (type: string, required: Yes, Group name)

addUserToGroup

userid (type: integer, required: Yes, User Id)
groupid (type: integer, required: Yes, Group Id)

subscriptionCreate

subject (type: string, required: Yes, Subject, choose from: task, project, goal, context, checklist)
subjectid (type: string, required: Yes, Subject Id)

contextCreate

name (type: string, required: Yes, Context name)
order (type: integer, Context order, default: 10)
color (type: string, Context background color)
bordercolor (type: string, Context border color)
textcolor (type: string, Context text color)
latitude (type: double, Context latitude)
longitude (type: double, Context longitude)
address (type: string, Context address)
visibility (type: string, Context visibility, choose from: everyone, private or group.)
groupid (type: integer, Group Id, used in conjunction with visibility type 'group'.)

projectCreate

name (type: string, required: Yes, Project name)
goalid (type: integer, Goal Id)
priority (type: integer, Project priority, 1-5)
duemonth (type: integer, Due month, eg: 10)
dueday (type: integer, Due day, eg: 29)
dueyear (type: integer, Due year, eg: 2012)
active (type: boolean, Active project, default: 1)
someday (type: boolean, Someday/Maybe project, default: 0)
archive (type: boolean, Archived project, default: 0)
done (type: boolean, Project closed, default: 0)
note (type: string, Project note)

projectDuplicate

id (type: integer, required: Yes, Project id)
name (type: string, Project name)
goalid (type: integer, Goal id)
withtasks (type: boolean, Copy with tasks, default: 1)

projectFilterCreate

name (type: string, required: Yes, Filter name)
shared (type: boolean, Shared filter, default: 0)
category (type: integer, Category id)
goal (type: integer, Goal id)
opened (type: integer, Opened)
closed (type: integer, Closed)
priorityrange (type: integer, Priority range)
priority (type: integer, Priority)
done (type: integer, Project closed, default:0)
active (type: integer, Active project, default:1)
someday (type: integer, Someday/Maybe project, default:0)
archive (type: integer, Archived project, default:0)
sortby (type: integer, Sort by)
sortby2 (type: integer, Then by)
sortby3 (type: integer, Then by)
limit (type: integer, Projects per page, use 0 for unlimited.)

taskCreate

name (type: string, required: Yes, Task name)
type (type: string, Task type, use: 'task' (default), 'memo', 'meeting' or 'birthday')
tasktypeid (type: integer, Task type Id)
assignedto (type: string, Assigned to User id)
priority (type: integer, Task priority, 1-5)
projectid (type: integer, Project id)
contextid (type: integer, Context id)
next (type: boolean, Next Action, default: 0)
duemonth (type: integer, Due month, eg: 10)
dueday (type: integer, Due day, eg: 29)
dueyear (type: integer, Due year, eg: 2012)
duedatehuman (type: string, Can be used instead of duemonth+dueday+dueyear, eg 05/06/2013. Takes into account the user's date format (us/eu).)
duehour (type: integer, Due hour, eg: 14)
dueminute (type: integer, Due minute, eg: 50)
duration (type: integer, Duration in seconds)
repeats (type: string, Task Repeats. Accepted values: 'no', 'day', 'weekday', 'week', 'month', or 'year')
active (type: boolean, Active task, default: 1)
someday (type: boolean, Someday/Maybe task, default: 0)
archive (type: boolean, Archived task, default: 0)
done (type: boolean, Task done, default: 0)
note (type: string, Task note)

taskTypeCreate

name (type: string, required: Yes, Task type name)
default (type: boolean, If set to 1 will make the task type default)

subTaskCreate

taskid (type: integer, required: Yes, Task Id)
name (type: string, required: Yes, Subtask name)
order (type: integer, Subtask order, 1-99, default:10)
done (type: boolean, Subtask done, default:0)

taskFilterCreate

name (type: string, required: Yes, Filter name)
shared (type: boolean, Shared filter, default: 0)
done (type: boolean, Task done, use: -1,0,1, default:0)
search (type: string, Search string in task name or note)
category (type: integer, Category id)
goal (type: integer, Goal id)
project (type: integer, Project id)
context (type: integer, Context id)
type (type: integer, Task type id)
next (type: boolean, Next action)
priorityrange (type: integer, Priority range)
priority (type: integer, Priority)
opened (type: integer, Opened)
closed (type: integer, Closed)
due (type: integer, Due)
month (type: integer, Due month)
day (type: integer, Due day)
year (type: integer, Due year)
active (type: integer, Active task, default:1)
someday (type: integer, Someday/Maybe task, default:0)
archive (type: integer, Archived task, default:0)
sortby (type: integer, Sort by)
sortby2 (type: integer, Then by)
sortby3 (type: integer, Then by)
limit (type: integer, Tasks per page, use 0 for max.)

currentTaskFilterSave

presaved (type: string, Presaved filter: inbox,next or null)
name (type: string, required: Yes, Filter name, if changed the filter will be saved as new)

currentTaskFilterReset

presaved (type: string, Presaved filter: inbox,next or null)

goalCreate

name (type: string, required: Yes, Goal name)
priority (type: integer, Goal priority 1-5)
timeline (type: string, required: Yes, Goal timeline, 3m, 3y etc)
categoryid (type: integer, Category Id)
active (type: boolean, Active goal, default: 1)
someday (type: boolean, Someday/Maybe goal, default: 0)
archive (type: boolean, Archived goal, default: 0)
done (type: boolean, Goal done, default 0)
note (type: string, Goal note)
color (type: string, Goal background color)
bordercolor (type: string, Goal border color)
textcolor (type: string, Goal text color)

goalCategoryCreate

name (type: string, required: Yes, Category name)
order (type: integer, Category sort order)

checkGroupCreate

name (type: string, required: Yes, Checkgroup name)
checksaday (type: integer, required: Yes, How many checkboxes in a day)
checkgrouplabelid (type: integer, Label Id)
monday (type: boolean, required: Yes, Due on Monday)
tuesday (type: boolean, required: Yes, Due on Tuesday)
wednesday (type: boolean, required: Yes, Due on Wednesday)
thursday (type: boolean, required: Yes, Due on Thursday)
friday (type: boolean, required: Yes, Due on Friday)
saturday (type: boolean, required: Yes, Due on Saturday)
sunday (type: boolean, required: Yes, Due on Sunday)
priority (type: integer, Priority)
assignedto (type: integer, Assigned to User id)
contextid (type: integer, Context id)
projectid (type: integer, Project id)
visibility (type: string, Checkgroup visibility, choose from: everyone, private or group.)
groupid (type: integer, Group Id, used in conjunction with visibility type 'group'.)

checkBoxCreate

checkgroupid (type: integer, required: Yes, Checkgroup id)
name (type: integer, required: Yes, Checkbox name. Correct format: {year}-{month}-{day}-{checkgroupid}-{position} .)

checkGroupLabelCreate

name (type: string, required: Yes, Label name)

fileCreate

file (type: data, POST file data)
projectid (type: integer, Project Id)
contextid (type: integer, Context Id)
taskid (type: integer, Task Id)

noteCreate

subject (type: string, required: Yes, What is this note about, choose from: goal, project, context, task)
subjectid (type: integer, required: Yes, Subject Id)
content (type: string, required: Yes, Note content)

customFieldCreate

subject (type: string, required: Yes, Subject: [project,context,task])
name (type: string, required: Yes, Custom field name, alphanumeric)

customFieldValueSet

subject (type: string, required: Yes, Subject: [project,context,task])
subjectid (type: integer, required: Yes, Subject Id)
fieldname (type: string, required: Yes, Custom field name)
value (type: string, required: Yes, Custom field value)

pushSubscriptionCreate

medium (type: string, required: Yes, Subscription medium, eg: http, email, email_json, sms.)
endpoint (type: string, required: Yes, Subscription endpoint.)
description (type: string, Subscription description.)

Introduction

Account

Users

Groups

Subscriptions

Priorities

Contexts

Projects

Calendar

Tasks

Goals

Checklists

Files

Notes

Custom Fields

Notifications


LISTING

VIEWING

CREATING

MODIFYING

DELETING


Reference Data