ToDos
Retrieve ToDos on Basecamp 3.
Table Specific Information
Select
The following columns are supported as search criteria by Basecamp:
- ProjectId
- ToDoListId
- Id
- Completed
- Status
By default, only active to-dos will be retrieved.
If ProjectId is not specified in the query, the default ProjectId will be used.
SELECT * FROM ToDos WHERE ProjectId = '11111111' AND ToDoListId = '222222222' AND Status = 'active' AND Completed = True
You can also retrieve a single to-do by specifying the Id.
SELECT * FROM ToDos WHERE ProjectId = '11111111' AND Id = '33333333'
Insert
You can insert a new to-do by providing the required ProjectId, ToDoListId, and Content in addition to the to-do related parameters.
INSERT INTO ToDos (Content, Description, DueOn, StartsOn, AssigneeIds, ProjectId, ToDoListId ) VALUES ('What to do', 'description', '2017-11-11', '2017-11-12', '333333333', '1111111111', '22222222')
Update
You can change the columns that are not read-only by providing the ProjectId, to-do Id, and new values.
UPDATE ToDos SET Content = 'Updated content' WHERE ProjectId = '11111111' AND Id = '1234567689'
You can change the Completed state of the to-do by providing the ProjectId and to-do Id. The Completed column can only be updated standalone, and other columns cannot be updated in the same query.
UPDATE ToDos SET Completed = True WHERE ProjectId = '11111111' AND Id = '1234567689'
Delete
To-dos cannot be deleted.
Columns
Name | Type | ReadOnly | References | Description |
Id [KEY] | Long | True |
The unique identifier of the todo. | |
ProjectId | Long | True |
Projects.Id |
The Id of the Project associated with the to-do list. |
ToDoListId | Long | True |
ToDoLists.Id |
The Id of the To Do list the to-do belongs to. |
Status | String | True |
The state the todo. | |
CreatedAt | Datetime | True |
The date and time when the event was created. | |
UpdatedAt | Datetime | True |
The date and time when the record was last updated. | |
StartsOn | Date | False |
The date and time when the todo should start. | |
DueOn | Date | False |
The date and time when the todo is due. | |
CommentsCount | Integer | True |
Number of coments the document has. | |
Description | String | False |
The to-do list description. | |
Content | String | False |
What to do. | |
AssigneesIds | String | False |
List of assigned user Ids. | |
Completed | Boolean | False |
The to-do state. | |
CompletedAt | Datetime | True |
The tdate and time when the todo was completed. | |
CompletionCreatorId | String | True |
The id of the user who completed the todo. | |
CompletionCreatorName | String | True |
The name of the user who completed the todo. | |
BucketName | String | True |
The to-do list bucket name. | |
BucketType | String | True |
The to-do list bucket type. | |
ParentTitle | String | True |
Title of the parent. | |
ParentType | String | True |
Type of the parent. | |
CreatorId | Long | True |
People.Id |
Event creator Id. |
CreatorAttachableSgid | String | True |
Event creator Attachable SGID. | |
CreatorName | String | True |
Event creator Name. | |
CreatorEmailAddress | String | True |
Event creator Email Address. | |
CreatorTitle | String | True |
Event creator Title. | |
CreatorBio | String | True |
Event creator Bio. | |
CreatorCreatedAt | Datetime | True |
Event creator creation date and time. | |
CreatorUpdatedAt | Datetime | True |
Event creator update date and time. | |
CreatorAdmin | Boolean | True |
Boolean indicationg if the event creator is an admin. | |
CreatorOwner | Boolean | True |
Boolean indicationg if the event creator is an owner. | |
CreatorTimeZone | String | True |
Event creator's timezone. | |
CreatorCompanyId | String | True |
Event creator's company Id. | |
CreatorCompanyName | String | True |
Event creator's company name. |