The glorious WeekPlan API documentation

ActionComments

Create a new comment.

Parameters

actionIdId of the actionSystem.Int64
textComment textSystem.String
usersSystem.String
actionRepetitionIdIf the task is a virtual representation of the repetition series, you need to pass the repetition id.System.Nullable`1[System.Int64]
actionDateIf the task is a virtual representation of the repetition series, you also need to pass the date of the task.System.Nullable`1[System.DateTime]

EmailNotifications

Parameters

sourceSystem.String

Parameters

sourceSystem.String

Parameters

sourceSystem.String

GoogleCalendarSync

Parameters

codeSystem.String

Invoice

Get User's workspace Analytics

Analytics

Get User's workspace Analytics

Parameters

userIdSystem.Int64
workspaceIdSystem.Int64
durationSystem.Int32

Logs

Log a message in the database for error debugging.

Parameters

logWeekPlan.Models.Log

ActionUsers

This action will assign task to action

Parameters

actionIdSystem.Int64
subscriberIduser idSystem.Int64

IncomingEmails

Invitations

Parameters

codeSystem.String

Send an invitation to a workspace

Parameters

workspaceIdWorkspace to invite the person toSystem.Int64
emailAddressEmail address to send the invite toSystem.String
messageCustom message written by the userSystem.String

Sessions

Logs the user out

Parameters

stateSystem.Nullable`1[System.Int32]
codeSystem.String

Authenticates the user and return the authentication cookie in the response.

Parameters

emailAddressSystem.String
passwordSystem.String
timezoneSystem.Int32

Account

Get all the data related to the logged in user. It bundles everything into one request.

Parameters

timezoneUser's local timezoneSystem.Int32
yearYear of the weekplan you want to fetchSystem.String
monthMonth of the weekplan you want to fetchSystem.String
dayAny day within the week of the weekplan you want to fetchSystem.String
skipSystem.Nullable`1[System.Int32]
takeSystem.Nullable`1[System.Int32]

DEPRECATED: Use Patch instead to set the new workspace id. Change the current workspace to remember. This can be used to reopen the app on the last workspace the user used.

Parameters

workspaceIdId of the workspace you want to change to.System.Int64
referrerReferrer code.System.String

Deactivate the current user account. User will not be able to log in anymore.

Change the password of the current user

Parameters

newPasswordSystem.String

Change the email of the current user.

Parameters

newEmailSystem.String

Forces a reset of the password of the user.

Parameters

emailSystem.String

Set Profile against already existing user

Parameters

usernameSystem.String
ageSystem.Nullable`1[System.Int16]
countrySystem.String
sectorSystem.Nullable`1[System.Int16]
companySizeSystem.Nullable`1[System.Int32]
managePeopleCountSystem.Nullable`1[System.Int32]
hearAboutWeekplanSystem.String

Create a new user

Parameters

emailAddressSystem.String
passwordSystem.String
usernameSystem.String
timezoneSystem.Int32
subscribeMeSystem.Nullable`1[System.Boolean]
referrerSystem.String

Unsubscribe a user from all emails or from a specific workspace

Parameters

idGUID of the userSystem.String
workspaceIdToUnsubscribe[optional] Id of the workspace to unsubscribe fromSystem.Nullable`1[System.Int64]

Change Daily Summary Sending Frequency for a particular user

Parameters

idGUID of the userSystem.String
notificationFrequencySystem.Int32
workspaceIdToUnsubscribeId of the workspace to change frequency forSystem.Int64

Validate the phone number of the user

Parameters

idGUID of the userSystem.String

Give Pro License to Basic Users

Parameters

identifierSystem.String

Give Pro License to Basic Users

Parameters

identifierSystem.String

ActionLists

Add or edit a new action list.

Parameters

actionListIdId of the listSystem.Int64
workspaceIdSystem.Int64
dayName of the listSystem.String
roleIdDefault role to assign new tasks toSystem.Nullable`1[System.Int64]

Parameters

workspaceIdSystem.Int64
withTasksSystem.Nullable`1[System.Boolean]
skipSystem.Nullable`1[System.Int32]
takeSystem.Nullable`1[System.Int32]
includeIsPendingSystem.Boolean
deepGetSystem.Boolean

Deletes an action list

Parameters

actionListIdList to deleteSystem.Int64

Actions

Parameters

actionIdSystem.Int64
actionTextSystem.String
roleIdSystem.Nullable`1[System.Int64]
notesSystem.String
isWeeklySystem.Boolean
sourceSystem.Boolean
actionRepetitionIdSystem.Nullable`1[System.Int64]
dateSystem.Nullable`1[System.DateTime]
actionListIdSystem.Nullable`1[System.Int64]
parentActionIdSystem.Nullable`1[System.Int64]
smsReminderSystem.Nullable`1[System.Boolean]
emailReminderSystem.Nullable`1[System.Boolean]
startTimeSystem.Nullable`1[System.Int32]
endTimeSystem.Nullable`1[System.Int32]
timeReminderSystem.Nullable`1[System.Int32]
orderSystem.String
googleEventIdSystem.String
quadrantSystem.Int16
spentTimeValueSystem.Nullable`1[System.Int32]
spentTimeTypeSystem.Nullable`1[System.Int32]
estimatedTimeValueSystem.Nullable`1[System.Int32]
estimatedTimeTypeSystem.Nullable`1[System.Int32]
userIdSystem.Int64
workspaceIdSystem.Int64
isCompletedSystem.Nullable`1[System.Boolean]
weekDateSystem.Nullable`1[System.DateTime]
defaultParticipantIdSystem.Nullable`1[System.Int64]

Parameters

workspaceIdSystem.Int64
yearSystem.Int32
monthSystem.Int32
daySystem.Int32
dayDiffSystem.Int32
skipSystem.Int32
takeSystem.Nullable`1[System.Int32]

Parameters

workspaceIdSystem.Int64
actionListIdSystem.Int32
skipSystem.Int32
takeSystem.Nullable`1[System.Int32]

Edit Actions

Parameters

isCompletedSystem.Boolean
workspaceIdSystem.Int64
actionIdSystem.Int64
textSystem.String
roleIdSystem.Nullable`1[System.Int64]
notesSystem.String
notesHtmlSystem.String
isWeeklySystem.Boolean
actionRepetitionIdSystem.Nullable`1[System.Int64]
dateSystem.Nullable`1[System.DateTime]
oldDateSystem.Nullable`1[System.DateTime]
actionListIdSystem.Nullable`1[System.Int64]
smsReminderSystem.Nullable`1[System.Boolean]
emailReminderSystem.Nullable`1[System.Boolean]
startTimeSystem.Nullable`1[System.Int32]
endTimeSystem.Nullable`1[System.Int32]
timeReminderSystem.Nullable`1[System.Int32]
orderSystem.String
quadrantSystem.Nullable`1[System.Int16]
spentTimeValueSystem.Nullable`1[System.Int32]
spentTimeTypeSystem.Nullable`1[System.Int32]
estimatedTimeValueSystem.Nullable`1[System.Int32]
estimatedTimeTypeSystem.Nullable`1[System.Int32]
weekDateSystem.Nullable`1[System.DateTime]
actionUsersSystem.String
repetitionEndDateSystem.Nullable`1[System.DateTime]
frequencySystem.Nullable`1[System.Int32]
anniversaryDaySystem.Nullable`1[System.Int32]
anniversaryMonthSystem.Nullable`1[System.Int32]
daysOfWeekSystem.String
weeklyIntervalSystem.Nullable`1[System.Int32]
monthIntervalSystem.Nullable`1[System.Int32]
monthlyIntervalSystem.Nullable`1[System.Int32]
monthlySelectedDaySystem.Nullable`1[System.Int32]
monthDaySystem.Nullable`1[System.Int32]
monthOptionSystem.Nullable`1[System.Int16]
repetitionDateSystem.Nullable`1[System.DateTime]

Get an action / task

Parameters

actionIdId of the actionSystem.Int64

Parameters

actionIdSystem.Int64
isCompletedSystem.Nullable`1[System.Boolean]

Parameters

parentActionIdSystem.Int64
actionRepetitionIdSystem.Nullable`1[System.Int64]
actionDateSystem.Nullable`1[System.DateTime]
subTaskTextSystem.String

Sets the Order property of a list of actions. Expects a action[] parameter containing the action ids.

Parameters

workspaceIdSystem.String
limitSystem.Nullable`1[System.Int32]

Parameters

workspaceIdSystem.Int64

Parameters

workspaceIdSystem.Int64

Get list of actions that were changed after a certain dateTime

Parameters

ticksTicks after which actions were changed (UTC)System.Int64
workspaceIdWorkspace to fetch changes fromSystem.Int64
referrerReferrer codeSystem.String

Get All Tasks by Ticks

Parameters

ticksTicks after which Tasks are requiredSystem.Int64
workspaceIdSystem.Int64

Search task by text and notes

Parameters

searchTextstring to be searchedSystem.String

Parameters

actionIdSystem.Int64

Parameters

workspaceIdSystem.Int64
yearSystem.String
monthSystem.String
daySystem.String

JournalEntries

Parameters

workspaceIdSystem.Int64

Parameters

journalEntryIdSystem.Int64

Parameters

workspaceIdSystem.Int64
yearSystem.String
monthSystem.String
daySystem.String

Parameters

journalEntryIdSystem.Nullable`1[System.Int64]
workspaceIdSystem.Int64
textSystem.String
lessonsLearnedSystem.String
couldBeImprovedSystem.String
entryTypeSystem.Nullable`1[System.Int32]
yearSystem.String
monthSystem.String
daySystem.String

Parameters

workspaceIdSystem.Int64

Plan

Get the whole week data (weeklyRoles with their goals, and weekDays and their tasks)

Parameters

workspaceIdSystem.Int64
yearYear of the weekSystem.String
monthMonth of the weekSystem.String
dayAny day of the week. Based on the user preference, the first day of the week will be Monday or Sunday. I suggest you pass Wednesday to be safe.System.String
skipSystem.Nullable`1[System.Int32]
takeSystem.Nullable`1[System.Int32]
deepGetSystem.Boolean

Public

Get server UTC ticks

Roles

Parameters

workspaceIdSystem.Int64
yearSystem.Int32
monthSystem.Int32
daySystem.Int32

Get All Roles By WorkSpaceId

Parameters

workspaceIdWorkspace IdSystem.Int64

Parameters

roleIdSystem.Int64

Parameters

roleIdSystem.Int64

Edit or create a new role. Returns the Weekly Roles of the specified date

Parameters

yearStart of weekSystem.Int32
monthStart of weekSystem.Int32
dayStart of weekSystem.Int32
roleIdOnly provide if you want to create a new roleSystem.Nullable`1[System.Int64]
roleText of the roleSystem.String
colorColor picked by the user. At the moment, it is a number from 1 to 19System.String
momentumOn creation, should be 100.System.Nullable`1[System.Int32]
defaultParticipantIdWhat default participant to automatically add to all new tasksSystem.Nullable`1[System.Int32]
workspaceIdWorkspace idSystem.Int64

StripeWebhook

Subscription

Parameters

planSystem.String
tokenSystem.String
couponSystem.String

Parameters

tokenIdSystem.String

Parameters

newPlanSystem.String

Workspaces

Parameters

workspaceIdSystem.Int64

Parameters

workspaceIdSystem.Int64

Parameters

workspaceIdSystem.Int64

Parameters

workspaceIdSystem.Int64

Parameters

apiKeySystem.String
workspaceIdSystem.Int64

Remove User from Workspace

Parameters

workspaceIdWorkspace from which user has to be removedSystem.Int64
userIduser to removeSystem.Int64