{"payload":{"allShortcutsEnabled":false,"fileTree":{"sections":{"items":[{"name":"account.md","path":"sections/account.md","contentType":"file"},{"name":"attachments.md","path":"sections/attachments.md","contentType":"file"},{"name":"calendar_entries.md","path":"sections/calendar_entries.md","contentType":"file"},{"name":"categories.md","path":"sections/categories.md","contentType":"file"},{"name":"comments.md","path":"sections/comments.md","contentType":"file"},{"name":"companies.md","path":"sections/companies.md","contentType":"file"},{"name":"data_reference.md","path":"sections/data_reference.md","contentType":"file"},{"name":"files.md","path":"sections/files.md","contentType":"file"},{"name":"messages.md","path":"sections/messages.md","contentType":"file"},{"name":"people.md","path":"sections/people.md","contentType":"file"},{"name":"projects.md","path":"sections/projects.md","contentType":"file"},{"name":"time_tracking.md","path":"sections/time_tracking.md","contentType":"file"},{"name":"todo_list_items.md","path":"sections/todo_list_items.md","contentType":"file"},{"name":"todo_lists.md","path":"sections/todo_lists.md","contentType":"file"}],"totalCount":14},"":{"items":[{"name":"sections","path":"sections","contentType":"directory"},{"name":"README.md","path":"README.md","contentType":"file"}],"totalCount":2}},"fileTreeProcessingTime":6.948633,"foldersToFetch":[],"repo":{"id":4373654,"defaultBranch":"master","name":"basecamp-classic-api","ownerLogin":"basecamp","currentUserCanPush":false,"isFork":false,"isEmpty":false,"createdAt":"2012-05-18T21:18:07.000Z","ownerAvatar":"https://avatars.githubusercontent.com/u/13131?v=4","public":true,"private":false,"isOrgOwned":true},"symbolsExpanded":false,"treeExpanded":true,"refInfo":{"name":"master","listCacheKey":"v0:1437976064.0","canEdit":false,"refType":"branch","currentOid":"da25ca154ba1ff8be52e65a81c163ea011755041"},"path":"sections/todo_list_items.md","currentUser":null,"blob":{"rawLines":null,"stylingDirectives":null,"colorizedLines":null,"csv":null,"csvError":null,"dependabotInfo":{"showConfigurationBanner":false,"configFilePath":null,"networkDependabotPath":"/basecamp/basecamp-classic-api/network/updates","dismissConfigurationNoticePath":"/settings/dismiss-notice/dependabot_configuration_notice","configurationNoticeDismissed":null},"displayName":"todo_list_items.md","displayUrl":"https://github.com/basecamp/basecamp-classic-api/blob/master/sections/todo_list_items.md?raw=true","headerInfo":{"blobSize":"4.56 KB","deleteTooltip":"You must be signed in to make or propose changes","editTooltip":"You must be signed in to make or propose changes","ghDesktopPath":"https://desktop.github.com","isGitLfs":false,"onBranch":true,"shortPath":"a5570c9","siteNavLoginPath":"/login?return_to=https%3A%2F%2Fgithub.com%2Fbasecamp%2Fbasecamp-classic-api%2Fblob%2Fmaster%2Fsections%2Ftodo_list_items.md","isCSV":false,"isRichtext":true,"toc":[{"level":1,"text":"Todo List Items","anchor":"todo-list-items","htmlText":"Todo List Items"},{"level":2,"text":"Get all items (for a list)","anchor":"get-all-items-for-a-list","htmlText":"Get all items (for a list)"},{"level":2,"text":"Get item","anchor":"get-item","htmlText":"Get item"},{"level":2,"text":"Complete item","anchor":"complete-item","htmlText":"Complete item"},{"level":2,"text":"Uncomplete item","anchor":"uncomplete-item","htmlText":"Uncomplete item"},{"level":2,"text":"New item","anchor":"new-item","htmlText":"New item"},{"level":2,"text":"Create item","anchor":"create-item","htmlText":"Create item"},{"level":2,"text":"Update item","anchor":"update-item","htmlText":"Update item"},{"level":2,"text":"Edit item","anchor":"edit-item","htmlText":"Edit item"},{"level":2,"text":"Destroy item","anchor":"destroy-item","htmlText":"Destroy item"},{"level":2,"text":"Reorder items","anchor":"reorder-items","htmlText":"Reorder items"}],"lineInfo":{"truncatedLoc":"172","truncatedSloc":"106"},"mode":"file"},"image":false,"isCodeownersFile":null,"isPlain":false,"isValidLegacyIssueTemplate":false,"issueTemplate":null,"discussionTemplate":null,"language":"Markdown","languageID":222,"large":false,"planSupportInfo":{"repoIsFork":null,"repoOwnedByCurrentUser":null,"requestFullPath":"/basecamp/basecamp-classic-api/blob/master/sections/todo_list_items.md","showFreeOrgGatedFeatureMessage":null,"showPlanSupportBanner":null,"upgradeDataAttributes":null,"upgradePath":null},"publishBannersInfo":{"dismissActionNoticePath":"/settings/dismiss-notice/publish_action_from_dockerfile","releasePath":"/basecamp/basecamp-classic-api/releases/new?marketplace=true","showPublishActionBanner":false},"rawBlobUrl":"https://github.com/basecamp/basecamp-classic-api/raw/master/sections/todo_list_items.md","renderImageOrRaw":false,"richText":"

Todo List Items

\n

For the full XML representation of todo items, check out the data reference.

\n

Get all items (for a list)

\n\n

This is almost the same as the “Get list” action, except it does not return any information about the list itself. The items are returned in priority order, as defined by how they were ordered either in the web UI, or via the “Reorder items” action.

\n

Response:

\n
<todo-items type=\"array\">\n  <todo-item>\n    ...\n  </todo-item>\n  ...\n</todo-items>
\n

Get item

\n\n

Response:

\n
<todo-item>\n  ...\n</todo-item>
\n

Complete item

\n\n

Response:

\n

Returns HTTP status code 200 on success.

\n

Uncomplete item

\n\n

If the specified todo item was previously marked as completed, this unmarks it, restoring it to an “uncompleted” state. If it was already in the uncompleted state, this call has no effect.

\n

Response:

\n

Returns HTTP status code 200 on success.

\n

New item

\n\n

Just fill in the fields and submit the data as indicated by the custom X-Create-Action HTTP header.

\n

Response:

\n
<todo-item>\n  ...\n</todo-item>
\n

Create item

\n\n

The new record begins its life in the uncompleted state. (See the “Complete” and “Uncomplete” actions.) It is added at the bottom of the given list. If a person is responsible for the item, give their id as the party_id value. If a company is responsible, prefix their company id with a ‘c’ and use that as the party_id value. If the item has a person as the responsible party, you can also use the notify key to indicate whether an email should be sent to that person to tell them about the assignment.

\n

Request:

\n
<todo-item>\n  <content>#{content}</content>\n\n  <!-- if the item has a due date (in the company time zone) -->\n  <due-at>#{due_at}</due-at>\n\n  <!-- if the item has a responsible party -->\n  <responsible-party>#{party_id}</responsible-party>\n  <notify type=\"boolean\">#{true|false}</notify>\n</todo-item>
\n

Response:

\n

Returns HTTP status code 201 Created on success, with the Location header being set to the URL for the new item. (The new item’s integer ID may be extractd from that URL.)

\n

Update item

\n\n

See the “Create item” action for a full discussion of the meaning of the data fields.

\n

Request:

\n
<todo-item>\n  <content>#{content}</content>\n\n  <!-- if the item has a responsible party -->\n  <responsible-party>#{party_id}</responsible-party>\n  <notify type=\"boolean\">#{true|false}</notify>\n</todo-item>
\n

Response:

\n

Returns HTTP status code 200 on success.

\n

Edit item

\n\n

A custom HTTP header, X-Update-Action, is also given, indicating where and how the data may be submitted.

\n

Response:

\n
<todo-item>\n  ...\n</todo-item>
\n

Destroy item

\n\n

Response:

\n

Returns HTTP status code 200 on success.

\n

Reorder items

\n\n

Completed items cannot be reordered, and any items not specified will be sorted after the items explicitly given (allowing you to easily move a single item to the head of the list without having to specify the positions of all the other items). You may reparent items by putting items from one list into the ordering of items for a different list (though items cannot be reparented across project boundaries).

\n

Request:

\n
<todo-items type=\"array\">\n  <todo-item><id>#{id}</id></todo-item>\n  ...\n</todo-items>
\n

Response:

\n

Returns HTTP status code 200 on success.

\n
","renderedFileInfo":null,"shortPath":null,"symbolsEnabled":true,"tabSize":8,"topBannersInfo":{"overridingGlobalFundingFile":false,"globalPreferredFundingPath":null,"showInvalidCitationWarning":false,"citationHelpUrl":"https://docs.github.com/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-citation-files","actionsOnboardingTip":null},"truncated":false,"viewable":true,"workflowRedirectUrl":null,"symbols":{"timed_out":false,"not_analyzed":false,"symbols":[{"name":"Todo List Items","kind":"section_1","ident_start":0,"ident_end":15,"extent_start":0,"extent_end":32,"fully_qualified_name":"Todo List Items","ident_utf16":{"start":{"line_number":0,"utf16_col":0},"end":{"line_number":0,"utf16_col":15}},"extent_utf16":{"start":{"line_number":0,"utf16_col":0},"end":{"line_number":2,"utf16_col":0}}},{"name":"Get all items (for a list)","kind":"section_2","ident_start":212,"ident_end":238,"extent_start":212,"extent_end":266,"fully_qualified_name":"Get all items (for a list)","ident_utf16":{"start":{"line_number":5,"utf16_col":0},"end":{"line_number":5,"utf16_col":26}},"extent_utf16":{"start":{"line_number":5,"utf16_col":0},"end":{"line_number":7,"utf16_col":0}}},{"name":"Get item","kind":"section_2","ident_start":744,"ident_end":752,"extent_start":744,"extent_end":762,"fully_qualified_name":"Get item","ident_utf16":{"start":{"line_number":24,"utf16_col":0},"end":{"line_number":24,"utf16_col":8}},"extent_utf16":{"start":{"line_number":24,"utf16_col":0},"end":{"line_number":26,"utf16_col":0}}},{"name":"Complete item","kind":"section_2","ident_start":911,"ident_end":924,"extent_start":911,"extent_end":939,"fully_qualified_name":"Complete item","ident_utf16":{"start":{"line_number":38,"utf16_col":0},"end":{"line_number":38,"utf16_col":13}},"extent_utf16":{"start":{"line_number":38,"utf16_col":0},"end":{"line_number":40,"utf16_col":0}}},{"name":"Uncomplete item","kind":"section_2","ident_start":1082,"ident_end":1097,"extent_start":1082,"extent_end":1114,"fully_qualified_name":"Uncomplete item","ident_utf16":{"start":{"line_number":48,"utf16_col":0},"end":{"line_number":48,"utf16_col":15}},"extent_utf16":{"start":{"line_number":48,"utf16_col":0},"end":{"line_number":50,"utf16_col":0}}},{"name":"New item","kind":"section_2","ident_start":1450,"ident_end":1458,"extent_start":1450,"extent_end":1468,"fully_qualified_name":"New item","ident_utf16":{"start":{"line_number":60,"utf16_col":0},"end":{"line_number":60,"utf16_col":8}},"extent_utf16":{"start":{"line_number":60,"utf16_col":0},"end":{"line_number":62,"utf16_col":0}}},{"name":"Create item","kind":"section_2","ident_start":1781,"ident_end":1792,"extent_start":1781,"extent_end":1805,"fully_qualified_name":"Create item","ident_utf16":{"start":{"line_number":76,"utf16_col":0},"end":{"line_number":76,"utf16_col":11}},"extent_utf16":{"start":{"line_number":76,"utf16_col":0},"end":{"line_number":78,"utf16_col":0}}},{"name":"Update item","kind":"section_2","ident_start":2950,"ident_end":2961,"extent_start":2950,"extent_end":2974,"fully_qualified_name":"Update item","ident_utf16":{"start":{"line_number":103,"utf16_col":0},"end":{"line_number":103,"utf16_col":11}},"extent_utf16":{"start":{"line_number":103,"utf16_col":0},"end":{"line_number":105,"utf16_col":0}}},{"name":"Edit item","kind":"section_2","ident_start":3446,"ident_end":3455,"extent_start":3446,"extent_end":3466,"fully_qualified_name":"Edit item","ident_utf16":{"start":{"line_number":127,"utf16_col":0},"end":{"line_number":127,"utf16_col":9}},"extent_utf16":{"start":{"line_number":127,"utf16_col":0},"end":{"line_number":129,"utf16_col":0}}},{"name":"Destroy item","kind":"section_2","ident_start":3792,"ident_end":3804,"extent_start":3792,"extent_end":3818,"fully_qualified_name":"Destroy item","ident_utf16":{"start":{"line_number":143,"utf16_col":0},"end":{"line_number":143,"utf16_col":12}},"extent_utf16":{"start":{"line_number":143,"utf16_col":0},"end":{"line_number":145,"utf16_col":0}}},{"name":"Reorder items","kind":"section_2","ident_start":3948,"ident_end":3961,"extent_start":3948,"extent_end":3976,"fully_qualified_name":"Reorder items","ident_utf16":{"start":{"line_number":153,"utf16_col":0},"end":{"line_number":153,"utf16_col":13}},"extent_utf16":{"start":{"line_number":153,"utf16_col":0},"end":{"line_number":155,"utf16_col":0}}}]}},"copilotInfo":null,"copilotAccessAllowed":false,"csrf_tokens":{"/basecamp/basecamp-classic-api/branches":{"post":"cqMD_G0iqnfbps5UmRps3OLysvM-St82S_aCnaVo1tbviPpqfhmP0Q4BP03F5gKa0MF_-KyhpLhM3HZPsJHvSg"},"/repos/preferences":{"post":"JRgRKkGM6M3YRZ6x0EpQHmCYSTLEwuWC6kCtMhq3QMlzoE_DnN63dfbryTxnmEajpHONKm_gczSZsw1pNB7G4Q"}}},"title":"basecamp-classic-api/sections/todo_list_items.md at master · basecamp/basecamp-classic-api"}