# vPlan ## Docs - [General](https://docs.api.vplan.com/general-377733f0.md): - General [Structure](https://docs.api.vplan.com/structure-344699m0.md): - General [Synchronize Data](https://docs.api.vplan.com/synchronize-data-344700m0.md): - General [Pagination](https://docs.api.vplan.com/pagination-344701m0.md): - General [Sorting](https://docs.api.vplan.com/sorting-344702m0.md): - General [Filtering](https://docs.api.vplan.com/filtering-344703m0.md): - General [Show & Hide](https://docs.api.vplan.com/show-hide-344704m0.md): - General [Eager Loading](https://docs.api.vplan.com/eager-loading-344705m0.md): - General [Deep Insertion](https://docs.api.vplan.com/deep-insertion-344706m0.md): - General [Deprecated](https://docs.api.vplan.com/deprecated-344707m0.md): - General [External Reference](https://docs.api.vplan.com/external-reference-344708m0.md): - General [Rate Limits](https://docs.api.vplan.com/rate-limits-344709m0.md): - General [Authentication](https://docs.api.vplan.com/authentication-377764f0.md): - General > Authentication [Me](https://docs.api.vplan.com/me-377767f0.md): - General [Errors](https://docs.api.vplan.com/errors-377765f0.md): - General > Errors [Empty values in created object](https://docs.api.vplan.com/empty-values-in-created-object-344713m0.md): - General > Errors [Memory Exhausted](https://docs.api.vplan.com/memory-exhausted-344714m0.md): - General > Errors [Report an issue](https://docs.api.vplan.com/report-an-issue-344715m0.md): - General > Errors [Service Unavailable](https://docs.api.vplan.com/service-unavailable-344716m0.md): - [Endpoints](https://docs.api.vplan.com/endpoints-377732f0.md): - Endpoints > Base Data [Board](https://docs.api.vplan.com/board-377739f0.md): - Endpoints > Base Data > Board [Label](https://docs.api.vplan.com/label-344671m0.md): - Endpoints > Base Data > Board [Status](https://docs.api.vplan.com/status-344672m0.md): - Endpoints > Base Data > Board [Capacity](https://docs.api.vplan.com/capacity-377746f0.md): - Endpoints > Base Data [Stage](https://docs.api.vplan.com/stage-377740f0.md): - Endpoints > Base Data [Activity](https://docs.api.vplan.com/activity-377741f0.md): - Endpoints > Base Data [Resource](https://docs.api.vplan.com/resource-377742f0.md): - Endpoints > Base Data [Schedule](https://docs.api.vplan.com/schedule-377743f0.md): - Endpoints > Base Data [Group](https://docs.api.vplan.com/group-377744f0.md): - Endpoints > Base Data [User](https://docs.api.vplan.com/user-377745f0.md): - Endpoints > Card Data [Collection](https://docs.api.vplan.com/collection-377747f0.md): - Endpoints > Card Data [Card](https://docs.api.vplan.com/card-377748f0.md): - Endpoints > Card Data [Attachment](https://docs.api.vplan.com/attachment-377749f0.md): - Endpoints > Card Data [Comment](https://docs.api.vplan.com/comment-377750f0.md): - Endpoints > Card Data [Checklist](https://docs.api.vplan.com/checklist-377751f0.md): - Endpoints > Card Data [Time Tracking](https://docs.api.vplan.com/time-tracking-377752f0.md): - Endpoints > Card Data [Relations between cards](https://docs.api.vplan.com/relations-between-cards-377753f0.md): - Endpoints > Order Data [Address](https://docs.api.vplan.com/address-344686m0.md): - Endpoints > Order Data [Order](https://docs.api.vplan.com/order-377758f0.md): - Endpoints > Order Data [Row](https://docs.api.vplan.com/row-377759f0.md): - Endpoints > Order Data [Item](https://docs.api.vplan.com/item-377760f0.md): - Endpoints > Order Data [Project](https://docs.api.vplan.com/project-377761f0.md): - Endpoints > Order Data [Relation](https://docs.api.vplan.com/relation-377762f0.md): - Endpoints > Order Data [Warehouse](https://docs.api.vplan.com/warehouse-377763f0.md): - Endpoints [Webhook](https://docs.api.vplan.com/webhook-377737f0.md): - Endpoints [Payload send to webhook url](https://docs.api.vplan.com/payload-send-to-webhook-url-377738f0.md): - Endpoints > Payload send to webhook url [Normal Object](https://docs.api.vplan.com/normal-object-344695m0.md): - Endpoints > Payload send to webhook url [Nested Object](https://docs.api.vplan.com/nested-object-344696m0.md): - Endpoints > Payload send to webhook url [Nested Object with Pivot](https://docs.api.vplan.com/nested-object-with-pivot-344697m0.md): ## API Docs - General > Authentication > Authentication [Get authorization](https://docs.api.vplan.com/get-authorization-3589290e0.md): In order to create access tokens for a specific vPlan environment, the Resource Owner has to authorize the app to access their vPlan environment. - General > Authentication > Authentication [Token Exchange](https://docs.api.vplan.com/token-exchange-3589291e0.md): After obtaining an authorization code, an access token can be requested on https://developer.mostwanted.io/api/v1/oauth/token - General > Authentication > Me [Retrieve information about current authentication](https://docs.api.vplan.com/retrieve-information-about-current-authentication-3589292e0.md): Show information about user, authentication details and customer environment for the authentication that is used. - General > Errors [Retrieve Api Messages](https://docs.api.vplan.com/retrieve-api-messages-3589293e0.md): The vPlan API is constantly improving, which means that today's endpoints and features could be replaced or removed in the future. - Endpoints > Base Data > Board > Capacity [Capacity Stage](https://docs.api.vplan.com/capacity-stage-3589178e0.md): - Endpoints > Base Data > Board > Capacity [Capacity Resource Type Stage](https://docs.api.vplan.com/capacity-resource-type-stage-3589179e0.md): - Endpoints > Base Data > Board > Capacity [Capacity Resource](https://docs.api.vplan.com/capacity-resource-3589180e0.md): - Endpoints > Base Data > Board > Capacity [Capacity Group](https://docs.api.vplan.com/capacity-group-3589181e0.md): - Endpoints > Base Data > Board [Retrieve Board List](https://docs.api.vplan.com/retrieve-board-list-3589173e0.md): Retrieve the Board List - Endpoints > Base Data > Board [Create New Board](https://docs.api.vplan.com/create-new-board-3589174e0.md): Create a new Board and store it - Endpoints > Base Data > Board [Retrieve Single Board](https://docs.api.vplan.com/retrieve-single-board-3589175e0.md): Retrieve a single Board - Endpoints > Base Data > Board [Update Single Board](https://docs.api.vplan.com/update-single-board-3589176e0.md): Update a single Board - Endpoints > Base Data > Board [Remove Single Board](https://docs.api.vplan.com/remove-single-board-3589177e0.md): Remove a single Board - Endpoints > Base Data > Stage [Retrieve Stage List](https://docs.api.vplan.com/retrieve-stage-list-3589182e0.md): Retrieve the Stage List - Endpoints > Base Data > Stage [Create New Stage](https://docs.api.vplan.com/create-new-stage-3589183e0.md): Create a new Stage and store it - Endpoints > Base Data > Stage [Retrieve Single Stage](https://docs.api.vplan.com/retrieve-single-stage-3589184e0.md): Retrieve a single Stage - Endpoints > Base Data > Stage [Update Single Stage](https://docs.api.vplan.com/update-single-stage-3589185e0.md): Update a single Stage - Endpoints > Base Data > Stage [Remove Single Stage](https://docs.api.vplan.com/remove-single-stage-3589186e0.md): Remove a single Stage - Endpoints > Base Data > Activity [Retrieve Activity List](https://docs.api.vplan.com/retrieve-activity-list-3589187e0.md): Retrieve the Activity List - Endpoints > Base Data > Activity [Create New Activity](https://docs.api.vplan.com/create-new-activity-3589188e0.md): Create a new Activity and store it - Endpoints > Base Data > Activity [Retrieve Single Activity](https://docs.api.vplan.com/retrieve-single-activity-3589189e0.md): Retrieve a single Activity - Endpoints > Base Data > Activity [Update Single Activity](https://docs.api.vplan.com/update-single-activity-3589190e0.md): Update a single Activity - Endpoints > Base Data > Activity [Remove Single Activity](https://docs.api.vplan.com/remove-single-activity-3589191e0.md): Remove a single Activity - Endpoints > Base Data > Resource [Retrieve Resource List](https://docs.api.vplan.com/retrieve-resource-list-3589192e0.md): Retrieve the Resource List - Endpoints > Base Data > Resource [Create New Resource](https://docs.api.vplan.com/create-new-resource-3589193e0.md): Create a new Resource and store it - Endpoints > Base Data > Resource [Retrieve Single Resource](https://docs.api.vplan.com/retrieve-single-resource-3589194e0.md): Retrieve a single Resource - Endpoints > Base Data > Resource [Update Single Resource](https://docs.api.vplan.com/update-single-resource-3589195e0.md): Update a single Resource - Endpoints > Base Data > Resource [Remove Single Resource](https://docs.api.vplan.com/remove-single-resource-3589196e0.md): Remove a single Resource - Endpoints > Base Data > Schedule [Retrieve Schedule List](https://docs.api.vplan.com/retrieve-schedule-list-3589197e0.md): Retrieve the Schedule List - Endpoints > Base Data > Schedule [Retrieve Schedule Year](https://docs.api.vplan.com/retrieve-schedule-year-3589198e0.md): Retrieve the Schedule List for the given year - Endpoints > Base Data > Schedule [Retrieve Schedule Month](https://docs.api.vplan.com/retrieve-schedule-month-3589199e0.md): Retrieve the Schedule List for the given year and month - Endpoints > Base Data > Schedule [Schedule Retrieve Day](https://docs.api.vplan.com/schedule-retrieve-day-3589200e0.md): Retrieve the Schedule List for the given year, month and day - Endpoints > Base Data > Group [Retrieve Group List](https://docs.api.vplan.com/retrieve-group-list-3589201e0.md): Retrieve the Group List - Endpoints > Base Data > Group [Create New Group](https://docs.api.vplan.com/create-new-group-3589202e0.md): Create a new Group and store it - Endpoints > Base Data > Group [Retrieve Single Group](https://docs.api.vplan.com/retrieve-single-group-3589203e0.md): Retrieve a single Group - Endpoints > Base Data > Group [Update Single Group](https://docs.api.vplan.com/update-single-group-3589204e0.md): Update a single Group - Endpoints > Base Data > Group [Remove Single Group](https://docs.api.vplan.com/remove-single-group-3589205e0.md): Remove a single Group - Endpoints > Base Data > User [Retrieve User List](https://docs.api.vplan.com/retrieve-user-list-3589206e0.md): Retrieve the User List - Endpoints > Base Data > User [Retrieve Single User](https://docs.api.vplan.com/retrieve-single-user-3589207e0.md): Retrieve a single User - Endpoints > Base Data > User [Update Single User](https://docs.api.vplan.com/update-single-user-3589208e0.md): Update a single User - Endpoints > Card Data > Collection > Custom Fields [Update Custom Field By Name](https://docs.api.vplan.com/update-custom-field-by-name-3589216e0.md): Update a single custom field by name - Endpoints > Card Data > Collection > Custom Fields [Delete Custom Field By Name](https://docs.api.vplan.com/delete-custom-field-by-name-3589217e0.md): Update a single custom field by name - Endpoints > Card Data > Collection [Retrieve Collection List](https://docs.api.vplan.com/retrieve-collection-list-3589209e0.md): Retrieve the Collection List - Endpoints > Card Data > Collection [Create New Collection](https://docs.api.vplan.com/create-new-collection-3589210e0.md): Create a new Collection and store it - Endpoints > Card Data > Collection [Retrieve Single Collection](https://docs.api.vplan.com/retrieve-single-collection-3589211e0.md): Retrieve a single Collection - Endpoints > Card Data > Collection [Remove Single Collection](https://docs.api.vplan.com/remove-single-collection-3589213e0.md): Remove a single Collection - Endpoints > Card Data > Collection [Move Collection to Backlog](https://docs.api.vplan.com/move-collection-to-backlog-3589214e0.md): Move planned Collection to Backlog - Endpoints > Card Data > Collection [Update Single Collection](https://docs.api.vplan.com/update-single-collection-3589212e0.md): Update a single Collection - Endpoints > Card Data > Collection [Move Collection to Board](https://docs.api.vplan.com/move-collection-to-board-3589215e0.md): Move a not planned collection to Board and create Cards accordingly - Endpoints > Card Data > Card > Custom Field [Update Custom Field By Name](https://docs.api.vplan.com/update-custom-field-by-name-3589224e0.md): Update a single custom field by name - Endpoints > Card Data > Card > Custom Field [Delete Custom Field By Name](https://docs.api.vplan.com/delete-custom-field-by-name-3589225e0.md): Update a single custom field by name - Endpoints > Card Data > Card [Retrieve Card List](https://docs.api.vplan.com/retrieve-card-list-3589218e0.md): Retrieve the Card List for this collection - Endpoints > Card Data > Card [Create New Card](https://docs.api.vplan.com/create-new-card-3589219e0.md): Create a new Card and store it for this collection - Endpoints > Card Data > Card [Retrieve Single Card](https://docs.api.vplan.com/retrieve-single-card-3589220e0.md): Retrieve a single Card from this collection - Endpoints > Card Data > Card [Update Single Card](https://docs.api.vplan.com/update-single-card-3589221e0.md): Update a single Card - Endpoints > Card Data > Card [Remove Single Card](https://docs.api.vplan.com/remove-single-card-3589222e0.md): Remove a single Card - Endpoints > Card Data > Card [Split Card](https://docs.api.vplan.com/split-card-3589223e0.md): You can split up a planned card into several new cards within the same collection. The number of resulting cards can be determined with the date_parts array. For each resulting card you can fill a planned date and a time value. This wil result in a new card on the chosen date, with the chosen time estimate. - Endpoints > Card Data > Card [All Cards List ](https://docs.api.vplan.com/all-cards-list-3603592e0.md): Retrieve the Card List - Endpoints > Card Data > Attachment [Retrieve Attachment List](https://docs.api.vplan.com/retrieve-attachment-list-3589226e0.md): Retrieve the Attachment List for this collection - Endpoints > Card Data > Attachment [Upload New Attachment](https://docs.api.vplan.com/upload-new-attachment-3589227e0.md): Upload a file as a new Attachment and store it for this collection - Endpoints > Card Data > Attachment [Add New Attachment Link](https://docs.api.vplan.com/add-new-attachment-link-3589228e0.md): Add a link as new Attachment and store it for this collection - Endpoints > Card Data > Attachment [Retrieve Single Attachment](https://docs.api.vplan.com/retrieve-single-attachment-3589229e0.md): Retrieve a single Attachment from this collection - Endpoints > Card Data > Attachment [Remove Single Attachment](https://docs.api.vplan.com/remove-single-attachment-3589230e0.md): Remove a single Attachment - Endpoints > Card Data > Comment [Retrieve Comment List](https://docs.api.vplan.com/retrieve-comment-list-3589231e0.md): Retrieve the Comment List for this collection - Endpoints > Card Data > Comment [Create New Comment](https://docs.api.vplan.com/create-new-comment-3589232e0.md): Create a new Comment and store it for this collection - Endpoints > Card Data > Comment [Retrieve Single Comment](https://docs.api.vplan.com/retrieve-single-comment-3589233e0.md): Retrieve a single Comment from this collection - Endpoints > Card Data > Comment [Update Single Comment](https://docs.api.vplan.com/update-single-comment-3589234e0.md): Update a single Comment - Endpoints > Card Data > Comment [Remove Single Comment](https://docs.api.vplan.com/remove-single-comment-3589235e0.md): Remove a single Comment - Endpoints > Card Data > Checklist > Collection [Retrieve Collection Checklist List](https://docs.api.vplan.com/retrieve-collection-checklist-list-3589236e0.md): Retrieve the Checklist List for this collection - Endpoints > Card Data > Checklist > Collection [Create New Collection Checklist](https://docs.api.vplan.com/create-new-collection-checklist-3589237e0.md): Create a new Checklist and store it for this collection - Endpoints > Card Data > Checklist > Collection [Retrieve Single Collection Checklist](https://docs.api.vplan.com/retrieve-single-collection-checklist-3589238e0.md): Retrieve a single Checklist from this collection - Endpoints > Card Data > Checklist > Collection [Update Single Collection Checklist](https://docs.api.vplan.com/update-single-collection-checklist-3589239e0.md): Update a single Collection Checklist - Endpoints > Card Data > Checklist > Collection [Remove Single Collection Checklist](https://docs.api.vplan.com/remove-single-collection-checklist-3589240e0.md): Remove a single Collection Checklist - Endpoints > Card Data > Checklist > Card [Retrieve Card Checklist List](https://docs.api.vplan.com/retrieve-card-checklist-list-3589241e0.md): Retrieve the Checklist List for this card - Endpoints > Card Data > Checklist > Card [Create New Card Checklist](https://docs.api.vplan.com/create-new-card-checklist-3589242e0.md): Create a new Checklist and store it for this card - Endpoints > Card Data > Checklist > Card [Retrieve Single Card Checklist](https://docs.api.vplan.com/retrieve-single-card-checklist-3589243e0.md): Retrieve a single Checklist from this card - Endpoints > Card Data > Checklist > Card [Update Single Card Checklist](https://docs.api.vplan.com/update-single-card-checklist-3589244e0.md): Update a single Card Checklist - Endpoints > Card Data > Checklist > Card [Remove Single Card Checklist](https://docs.api.vplan.com/remove-single-card-checklist-3589245e0.md): Remove a single Card Checklist - Endpoints > Card Data > Time Tracking [Retrieve TimeTracking List](https://docs.api.vplan.com/retrieve-timetracking-list-3589246e0.md): Retrieve the TimeTracking List for this card - Endpoints > Card Data > Time Tracking [Create New TimeTracking](https://docs.api.vplan.com/create-new-timetracking-3589247e0.md): Create a new TimeTracking and store it for this collection - Endpoints > Card Data > Time Tracking [Retrieve Single TimeTracking](https://docs.api.vplan.com/retrieve-single-timetracking-3589248e0.md): Retrieve a single TimeTracking from this collection - Endpoints > Card Data > Time Tracking [Update Single TimeTracking](https://docs.api.vplan.com/update-single-timetracking-3589249e0.md): Update a single TimeTracking - Endpoints > Card Data > Time Tracking [Remove Single TimeTracking](https://docs.api.vplan.com/remove-single-timetracking-3589250e0.md): Remove a single TimeTracking - Endpoints > Card Data > Time Tracking [Export TimeTracking](https://docs.api.vplan.com/export-timetracking-3613912e0.md): - Endpoints > Card Data > Relations between cards [Retrieve CardRelation List](https://docs.api.vplan.com/retrieve-cardrelation-list-3589251e0.md): Retrieve the CardRelation List - Endpoints > Card Data > Relations between cards [Create New CardRelation](https://docs.api.vplan.com/create-new-cardrelation-3589252e0.md): Create a new CardRelation and store it - Endpoints > Card Data > Relations between cards [Retrieve Single CardRelation](https://docs.api.vplan.com/retrieve-single-cardrelation-3589253e0.md): Retrieve a single CardRelation - Endpoints > Card Data > Relations between cards [Remove Single CardRelation](https://docs.api.vplan.com/remove-single-cardrelation-3589254e0.md): Remove a single CardRelation - Endpoints > Order Data > Order [Retrieve Order List](https://docs.api.vplan.com/retrieve-order-list-3589255e0.md): Retrieve the Order List - Endpoints > Order Data > Order [Create New Order](https://docs.api.vplan.com/create-new-order-3589256e0.md): Create a new Order and store it - Endpoints > Order Data > Order [Retrieve Single Order](https://docs.api.vplan.com/retrieve-single-order-3589257e0.md): Retrieve a single Order - Endpoints > Order Data > Order [Update Single Order](https://docs.api.vplan.com/update-single-order-3589258e0.md): Update a single Order - Endpoints > Order Data > Order [Remove Single Order](https://docs.api.vplan.com/remove-single-order-3589259e0.md): Remove a single Order - Endpoints > Order Data > Row [Retrieve OrderRow List](https://docs.api.vplan.com/retrieve-orderrow-list-3589260e0.md): Retrieve the OrderRow List - Endpoints > Order Data > Row [Create New OrderRow](https://docs.api.vplan.com/create-new-orderrow-3589261e0.md): Create a new OrderRow and store it - Endpoints > Order Data > Row [Retrieve Single OrderRow](https://docs.api.vplan.com/retrieve-single-orderrow-3589262e0.md): Retrieve a single OrderRow from the order - Endpoints > Order Data > Row [Update Single OrderRow](https://docs.api.vplan.com/update-single-orderrow-3589263e0.md): Update a single OrderRow - Endpoints > Order Data > Row [Remove Single OrderRow](https://docs.api.vplan.com/remove-single-orderrow-3589264e0.md): Remove a single OrderRow - Endpoints > Order Data > Item [Retrieve Item List](https://docs.api.vplan.com/retrieve-item-list-3589265e0.md): Retrieve the Item List - Endpoints > Order Data > Item [Create New Item](https://docs.api.vplan.com/create-new-item-3589266e0.md): Create a new Item and store it - Endpoints > Order Data > Item [Retrieve Single Item](https://docs.api.vplan.com/retrieve-single-item-3589267e0.md): Retrieve a single Item - Endpoints > Order Data > Item [Update Single Item](https://docs.api.vplan.com/update-single-item-3589268e0.md): Update a single Item - Endpoints > Order Data > Item [Remove Single Item](https://docs.api.vplan.com/remove-single-item-3589269e0.md): Remove a single Item - Endpoints > Order Data > Project [Retrieve Project List](https://docs.api.vplan.com/retrieve-project-list-3589270e0.md): Retrieve the Project List - Endpoints > Order Data > Project [Create New Project](https://docs.api.vplan.com/create-new-project-3589271e0.md): Create a new Project and store it - Endpoints > Order Data > Project [Retrieve Single Project](https://docs.api.vplan.com/retrieve-single-project-3589272e0.md): Retrieve a single Project - Endpoints > Order Data > Project [Update Single Project](https://docs.api.vplan.com/update-single-project-3589273e0.md): Update a single Project - Endpoints > Order Data > Project [Remove Single Project](https://docs.api.vplan.com/remove-single-project-3589274e0.md): Remove a single Project - Endpoints > Order Data > Relation [Retrieve Relation List](https://docs.api.vplan.com/retrieve-relation-list-3589275e0.md): Retrieve the Relation List - Endpoints > Order Data > Relation [Create New Relation](https://docs.api.vplan.com/create-new-relation-3589276e0.md): Create a new Relation and store it - Endpoints > Order Data > Relation [Retrieve Single Relation](https://docs.api.vplan.com/retrieve-single-relation-3589277e0.md): Retrieve a single Relation - Endpoints > Order Data > Relation [Update Single Relation](https://docs.api.vplan.com/update-single-relation-3589278e0.md): Update a single Relation - Endpoints > Order Data > Relation [Remove Single Relation](https://docs.api.vplan.com/remove-single-relation-3589279e0.md): Remove a single Relation - Endpoints > Order Data > Warehouse [Retrieve Warehouse List](https://docs.api.vplan.com/retrieve-warehouse-list-3589280e0.md): Retrieve the Warehouse List - Endpoints > Order Data > Warehouse [Create New Warehouse](https://docs.api.vplan.com/create-new-warehouse-3589281e0.md): Create a new Warehouse and store it - Endpoints > Order Data > Warehouse [Retrieve Single Warehouse](https://docs.api.vplan.com/retrieve-single-warehouse-3589282e0.md): Retrieve a single Warehouse - Endpoints > Order Data > Warehouse [Update Single Warehouse](https://docs.api.vplan.com/update-single-warehouse-3589283e0.md): Update a single Warehouse - Endpoints > Order Data > Warehouse [Remove Single Warehouse](https://docs.api.vplan.com/remove-single-warehouse-3589284e0.md): Remove a single Warehouse - Endpoints > Webhook [Retrieve Webhook List](https://docs.api.vplan.com/retrieve-webhook-list-3589285e0.md): Retrieve the Webhook List - Endpoints > Webhook [Create New Webhook](https://docs.api.vplan.com/create-new-webhook-3589286e0.md): Create a new Webhook and store it - Endpoints > Webhook [Retrieve Single Webhook](https://docs.api.vplan.com/retrieve-single-webhook-3589287e0.md): Retrieve a single Webhook - Endpoints > Webhook [Update Single Webhook](https://docs.api.vplan.com/update-single-webhook-3589288e0.md): Update a single Webhook - Endpoints > Webhook [Remove Single Webhook](https://docs.api.vplan.com/remove-single-webhook-3589289e0.md): Remove a single Webhook