### OpenAPI Specification for Create Activity Source: https://docs.api.vplan.com/create-activity-3589188e0 Defines the POST request for creating an activity, including request body schema, example, and response structure. ```yaml openapi: 3.0.1 info: title: '' description: '' version: 1.0.0 paths: /activity: post: summary: Create Activity deprecated: false description: Create a new Activity and store it tags: - Endpoints/Base Data/Activity - Activity parameters: [] requestBody: content: application/json: schema: type: object x-apidog-refs: 01JXHNR8MY6FGTRTAR2V12MWRD: &ref_1 $ref: '#/components/schemas/Activity' x-apidog-overrides: description: &ref_0 type: string x-apidog-mock: '{{$lorem.word}}' required: - description properties: id: type: string description: Unique identifier format: uuid readOnly: true x-apidog-mock: '{{$string.uuid}}' description: *ref_0 code: type: string item_id: type: string x-apidog-mock: '{{$string.uuid}}' format: uuid readOnly: true nullable: true resource_type: &ref_2 $ref: '#/components/schemas/ResourceType' default_duration: type: integer minimum: 0 day_max_duration: type: integer minimum: 0 billable: type: boolean hourly_rate: type: integer minimum: 0 external_ref: type: string description: >- Third-party reference of the object, for informational purposes only examples: - fb1033a2ed70 readOnly: true nullable: true created_at: type: string description: Date and time of creation format: date-time readOnly: true examples: - '2024-04-11T10:22:15Z' x-apidog-mock: '{{$date.recent}}' updated_at: type: string description: Date and time of last update format: date-time readOnly: true examples: - '2024-04-11T10:22:15Z' x-apidog-mock: '{{$date.recent}}' archived_at: type: string description: Date and time that the object is archived format: date-time readOnly: true examples: - '2021-07-06T11:24:35Z' nullable: true stages: anyOf: - $ref: '#/components/schemas/IdArray' - type: 'null' x-apidog-orders: - 01JXHNR8MY6FGTRTAR2V12MWRD - stages required: - description x-apidog-ignore-properties: - id - description - code - item_id - resource_type - default_duration - day_max_duration - billable - hourly_rate - external_ref - created_at - updated_at - archived_at example: external_ref: null description: Activity - Machine code: '' resource_type: machine default_duration: 0 day_max_duration: 0 billable: false hourly_rate: 0 responses: '201': description: '' content: application/json: schema: *ref_1 example: id: ab59295d-72ce-4e8a-bc74-5e6c4caad348 item_id: null external_ref: null transaction: null description: Activity - Machine code: '' resource_type: machine default_duration: 0 day_max_duration: 0 billable: false hourly_rate: 0 archived_at: null created_at: '2025-07-30T07:57:46Z' updated_at: '2025-07-30T07:57:46Z' headers: {} x-apidog-name: Created '401': description: '' content: application/json: schema: type: object properties: ``` -------------------------------- ### Create Board Source: https://docs.api.vplan.com/llms.txt Create a new board and store it in the vPlan environment. ```APIDOC ## Create Board ### Description Create a new Board and store it. ### Method POST ### Endpoint /boards ### Parameters #### Request Body - **name** (string) - Required - The name of the board. - **description** (string) - Optional - A description for the board. ``` -------------------------------- ### OpenAPI Specification for Retrieve Single Warehouse Source: https://docs.api.vplan.com/retrieve-single-warehouse-3589282e0 This OpenAPI 3.0.1 specification defines the GET endpoint for retrieving a single warehouse. It outlines the path parameters, response schemas for success and error cases, and example responses. ```yaml openapi: 3.0.1 info: title: '' description: '' version: 1.0.0 paths: /warehouse/{warehouse_id}: get: summary: Retrieve Single Warehouse deprecated: false description: Retrieve a single Warehouse tags: - Endpoints/Order Data/Warehouse - Warehouse parameters: - name: warehouse_id in: path description: '' required: true example: '' schema: type: string format: uuid responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/Warehouse' headers: {} x-apidog-name: Ok '401': description: '' content: application/json: schema: type: object properties: reference: type: string format: uuid readOnly: true description: Error reference, used for support requests errors: type: array items: type: object properties: code: type: integer description: >- Error code. May be the status code, but could also be a specific vPlan error code const: 401 message: type: string description: Error message const: Unauthorized description: type: string description: Additional information about the error const: Access denied due to invalid or expired token reference: type: string format: uuid description: Error reference, used for support requests timestamp: type: string format: date-time description: Date and time of the occurrence of the error x-apidog-mock: '{{$date.between}}' x-apidog-orders: - code - message - description - reference - timestamp required: - code - message - description - reference - timestamp x-apidog-ignore-properties: [] minItems: 1 uniqueItems: true readOnly: true x-apidog-refs: {} x-apidog-orders: - reference - errors required: - reference - errors x-apidog-ignore-properties: [] example: reference: 4eb4980d-8ea9-c71e-651c-aa2b71237ecd errors: - code: 401 message: Unauthorized description: Access denied due to invalid or expired token reference: 92504914-44b5-78ea-0870-50f22a0c0e9d timestamp: '2010-04-05T01:21:40.559Z' headers: {} x-apidog-name: Not Logged In '404': description: '' content: application/json: schema: type: object properties: {} headers: {} x-apidog-name: Not Found security: [] x-apidog-folder: Endpoints/Order Data/Warehouse x-apidog-status: released x-run-in-apidog: https://app.eu.apidog.com/web/project/347839/apis/api-3589282-run components: schemas: Warehouse: type: object properties: id: type: string description: Unique identifier format: uuid readOnly: true x-apidog-mock: '{{$string.uuid}}' name: description: '' type: string maxLength: 100 code: description: '' type: string maxLength: 50 external_ref: type: string description: Third-party reference of the object, for informational purposes only examples: - fb1033a2ed70 nullable: true created_at: type: string description: Date and time of creation format: date-time readOnly: true examples: - '2024-04-11T10:22:15Z' ``` -------------------------------- ### Create New Project Source: https://docs.api.vplan.com/llms.txt Create a new Project and store it. ```APIDOC ## Create New Project ### Description Create a new Project and store it. ### Method POST ### Endpoint /order-data/projects ``` -------------------------------- ### OpenAPI Specification for /me Endpoint Source: https://docs.api.vplan.com/me Defines the OpenAPI 3.0.1 schema for the GET /me endpoint. This includes the request summary, description, tags, parameters, and detailed response structure for a 200 OK status, including example data. ```yaml openapi: 3.0.1 info: title: '' description: '' version: 1.0.0 paths: /me: get: summary: Retrieve information about current authentication deprecated: false description: > Show information about user, authentication details and customer environment for the authentication that is used. tags: - General/Authentication/Me - Me parameters: [] responses: '200': description: '' content: application/json: schema: oneOf: - $ref: '#/components/schemas/ApiKey' - properties: type: type: string const: user environment: &ref_1 $ref: '#/components/schemas/Environment' host: type: object properties: id: type: string format: uuid description: type: string required: - id - description x-apidog-orders: - id - description ai_settings: type: object properties: general: type: boolean formula: type: boolean required: - general - formula x-apidog-orders: - general - formula user: &ref_2 $ref: '#/components/schemas/User' show_nps: type: boolean permissions: type: array items: type: string organizations: type: array items: type: object properties: id: type: string name: type: string current: type: boolean x-apidog-orders: - id - name - current identity_hash: type: string required: - type - environment - host - ai_settings - user - show_nps - permissions - organizations - identity_hash x-apidog-orders: - type - environment - host - ai_settings - user - show_nps - permissions - organizations - identity_hash $ref: '#/components/schemas/MeUser' example: type: user environment: id: 13050678-2f4d-8004-36da-14d8b791b59d hash: in Excepteur customer: quis status: nulla dolor ex last_login: null last_request_user: null last_request_third_party: null state_user: null state_third_party: null created_at: '2024-04-15T05:15:25.740Z' updated_at: '2024-04-15T07:12:32.963Z' host: id: c3e1777b-2f58-aa97-e31a-1a8cc7270435 description: >- Dolor nostrum saepe quia. Reprehenderit aperiam voluptatem quaerat. Minima architecto officia sequi consectetur suscipit odio illum. Mollitia blanditiis nobis harum nihil provident doloribus aliquid. ai_settings: general: false formula: true user: id: 4f6f90f4-d1f7-3cf5-a76f-85cfe2a5de13 idp_id: eu adipisicing dolor invite_id: null status: minim resource_id: null external_ref: null transaction: null firstname: Elwin lastname: Weimann ``` -------------------------------- ### Create Board Source: https://docs.api.vplan.com/create-board-3589174e0 Creates a new board with specified configurations. ```APIDOC ## POST /websites/api_vplan/boards ### Description Creates a new board with specified configurations. ### Method POST ### Endpoint /websites/api_vplan/boards ### Request Body - **name** (string) - Required - The name of the board. - **workdays** (object) - Optional - Defines the workdays for the board. - **1-7** (boolean) - Defines if the day is a workday. - **color** (string) - Optional - The color of the board. - **split_cards_by_activity** (boolean) - Optional - Whether to split cards by activity. - **own_backlog** (boolean) - Optional - Whether the board has its own backlog. - **capacity_method** (string) - Optional - The capacity method to use (e.g., none, estimated_time). - **visibility** (string) - Optional - The visibility of the board (e.g., everyone). - **labels** (array) - Optional - A list of labels for the board. - **name** (string) - Required - The name of the label. - **color** (string) - Required - The color of the label. - **statusses** (array) - Optional - A list of statuses for the board. - **name** (string) - Required - The name of the status. - **entry** (boolean) - Required - Whether a card can enter this status. - **exit** (boolean) - Required - Whether a card can exit this status. - **color** (string) - Required - The color of the status. ### Request Example { "name": "Test Board", "workdays": { "1": true, "2": true, "3": true, "4": true, "5": true, "6": false, "7": false }, "color": "pink", "split_cards_by_activity": true, "own_backlog": true, "capacity_method": "none", "visibility": "everyone", "labels": [ { "name": "Green", "color": "green" }, { "name": "Red", "color": "red" } ], "statusses": [ { "name": "Start", "entry": false, "exit": true, "color": "green" }, { "name": "Progress", "entry": false, "exit": false, "color": "orange" }, { "name": "Done", "entry": false, "exit": true, "color": "red" } ] } ### Response #### Success Response (201) - **id** (string) - The unique identifier of the created board. - **name** (string) - The name of the board. - **workdays** (object) - The workdays configuration. - **color** (string) - The color of the board. - **split_cards_by_activity** (boolean) - Indicates if cards are split by activity. - **own_backlog** (boolean) - Indicates if the board has its own backlog. - **capacity_method** (string) - The capacity method used. - **visibility** (string) - The visibility setting of the board. - **dependency_behavior** (string) - The behavior for dependencies. - **card_lock_options** (array) - Options for locking cards. - **archived_at** (string) - The timestamp when the board was archived. - **created_at** (string) - The timestamp when the board was created. - **updated_at** (string) - The timestamp when the board was last updated. - **permission_set** (string) - The permission set for the current user. #### Response Example { "id": "8afcb6b4-2006-44e1-a47e-4e3bb6f29b72", "name": "Production XYZ", "workdays": { "1": true, "2": true, "3": true, "4": true, "5": true, "6": false, "7": false }, "color": "teal", "split_cards_by_activity": true, "own_backlog": false, "capacity_method": "estimated_time", "visibility": "everyone", "dependency_behavior": "notify", "card_lock_options": [ "card.move", "card.edit.name", "card.edit.description", "card.edit.status", "card.edit.date", "card.edit.activities", "card.edit.resources", "card.edit.labels", "card.split", "card.clone", "card.delete", "time.register", "time.edit.other", "time.edit.own", "time.status", "checklist.add", "checklist.delete", "checklist.edit", "custom.field.card" ], "archived_at": null, "created_at": "2025-07-16T07:59:35Z", "updated_at": "2025-07-16T07:59:35Z", "permission_set": "can_manage" } #### Error Response (401) - **reference** (string) - Error reference, used for support requests ``` -------------------------------- ### OpenAPI Specification for Retrieve Deviation List Source: https://docs.api.vplan.com/retrieve-deviation-list-3809785e0 This OpenAPI 3.0.1 specification defines the GET endpoint for retrieving schedule deviations. It includes details on path parameters, response schemas for successful retrieval (200 OK) and unauthorized access (401 Unauthorized), and example error responses. ```yaml openapi: 3.0.1 info: title: '' description: '' version: 1.0.0 paths: /resource/{resource_id}/schedule_deviation: get: summary: Retrieve Deviation List deprecated: false description: Retrieve the Schedule List tags: - Endpoints/Base Data/Resource/Schedule Deviation - Schedule parameters: - name: resource_id in: path description: '' required: true example: 2ce36ba2-0957-4c28-a02c-7682f8ce5927 schema: type: string format: uuid responses: '200': description: '' content: application/json: schema: type: object x-apidog-refs: 01JW67A9FJN5QS5KTGG9C05KJJ: $ref: '#/components/schemas/List' x-apidog-overrides: data: &ref_0 type: array items: $ref: '#/components/schemas/Schedule%20Deviation' description: Items x-apidog-orders: - 01JW67A9FJN5QS5KTGG9C05KJJ properties: count: type: integer description: Total amount of items default: 1 minimum: 0 format: uint limit: type: integer description: Max amount of items fetched format: uint64 default: 100 minimum: 0 maximum: 1000 offset: type: integer description: Offset so items may be paginated format: uint64 default: 0 minimum: 0 data: *ref_0 x-apidog-ignore-properties: - count - limit - offset - data headers: {} x-apidog-name: Ok '401': description: '' content: application/json: schema: type: object properties: reference: type: string format: uuid readOnly: true description: Error reference, used for support requests errors: type: array items: type: object properties: code: type: integer description: >- Error code. May be the status code, but could also be a specific vPlan error code const: 401 message: type: string description: Error message const: Unauthorized description: type: string description: Additional information about the error const: Access denied due to invalid or expired token reference: type: string format: uuid description: Error reference, used for support requests timestamp: type: string format: date-time description: Date and time of the occurrence of the error x-apidog-mock: '{{$date.between}}' x-apidog-orders: - code - message - description - reference - timestamp required: - code - message - description - reference - timestamp x-apidog-ignore-properties: [] minItems: 1 uniqueItems: true readOnly: true x-apidog-refs: {} x-apidog-orders: - reference - errors required: - reference - errors x-apidog-ignore-properties: [] example: reference: 4eb4980d-8ea9-c71e-651c-aa2b71237ecd errors: - code: 401 message: Unauthorized description: Access denied due to invalid or expired token ``` -------------------------------- ### Error Response Example Source: https://docs.api.vplan.com/api_message_index Example of an error response indicating access denial due to an invalid or expired token. ```APIDOC ## Error Response: Access Denied ### Description This response is returned when the provided authentication token is invalid or has expired. ### Response Body Example ```json { "description": "Access denied due to invalid or expired token", "reference": "92504914-44b5-78ea-0870-50f22a0c0e9d", "timestamp": "2010-04-05T01:21:40.559Z" } ``` ``` -------------------------------- ### Create Board Source: https://docs.api.vplan.com/create-board-3589174e0 Creates a new board and stores it. ```APIDOC ## POST /board ### Description Create a new Board and store it. ### Method POST ### Endpoint /board ### Request Body - **name** (string) - Required - The name of the board. - **workdays** (object) - Required - Defines the workdays for the board. - **'1'** (boolean) - Required - **'2'** (boolean) - Required - **'3'** (boolean) - Required - **'4'** (boolean) - Required - **'5'** (boolean) - Required - **'6'** (boolean) - Required - **'7'** (boolean) - Required - **color** (object) - Optional - The color associated with the board. - **split_cards_by_activity** (boolean) - Optional - Whether to split cards by activity. Defaults to false. - **own_backlog** (boolean) - Optional - Whether the board has its own backlog. Defaults to false. - **capacity_method** (object) - Optional - The capacity method for the board. - **visibility** (object) - Optional - The visibility settings for the board. - **dependency_behavior** (object) - Optional - The dependency behavior for the board. - **custom_fields** (object) - Optional - Custom fields for the board. - **labels** (array) - Optional - A list of labels for the board. - **name** (string) - Required - The name of the label. - **color** (object) - Required - The color of the label. - **board_id** (string) - ReadOnly - Unique identifier of the Board. ### Request Example { "name": "New Project Board", "workdays": { "1": true, "2": true, "3": true, "4": true, "5": true, "6": false, "7": false }, "color": { "id": "#FF0000", "name": "Red" }, "split_cards_by_activity": true, "own_backlog": false, "capacity_method": { "type": "average" }, "visibility": { "type": "public" }, "dependency_behavior": { "type": "strict" }, "custom_fields": [ { "name": "Priority", "type": "dropdown", "options": ["High", "Medium", "Low"] } ], "labels": [ { "name": "Bug", "color": { "id": "#00FF00", "name": "Green" } } ] } ### Response #### Success Response (200) - **id** (string) - Unique identifier of the created board. - **name** (string) - The name of the board. - **workdays** (object) - Defines the workdays for the board. - **color** (object) - The color associated with the board. - **split_cards_by_activity** (boolean) - Whether cards are split by activity. - **own_backlog** (boolean) - Whether the board has its own backlog. - **capacity_method** (object) - The capacity method for the board. - **visibility** (object) - The visibility settings for the board. - **dependency_behavior** (object) - The dependency behavior for the board. - **custom_fields** (object) - Custom fields for the board. - **created_at** (string) - Date and time of creation. - **updated_at** (string) - Date and time of last update. - **archived_at** (string) - Date and time that the object is archived. - **labels** (array) - A list of labels for the board. #### Response Example { "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef", "name": "New Project Board", "workdays": { "1": true, "2": true, "3": true, "4": true, "5": true, "6": false, "7": false }, "color": { "id": "#FF0000", "name": "Red" }, "split_cards_by_activity": true, "own_backlog": false, "capacity_method": { "type": "average" }, "visibility": { "type": "public" }, "dependency_behavior": { "type": "strict" }, "custom_fields": [ { "name": "Priority", "type": "dropdown", "options": ["High", "Medium", "Low"] } ], "created_at": "2024-04-11T10:22:15Z", "updated_at": "2024-04-11T10:22:15Z", "archived_at": null, "labels": [ { "id": "l1m2n3o4-p5q6-7890-1234-567890rstuvw", "name": "Bug", "color": { "id": "#00FF00", "name": "Green" }, "board_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef", "created_at": "2024-04-11T10:22:15Z" } ] } ``` -------------------------------- ### Create New Project Source: https://docs.api.vplan.com/remove-single-card-3589222e0 Creates a new project. ```APIDOC ## Create New Project ### Description Creates a new project. ### Method POST ### Endpoint /projects ``` -------------------------------- ### Update Board Request Body Example Source: https://docs.api.vplan.com/update-board-3589176e0 Provides an example of the JSON payload required to update a board, including custom fields. ```json { "name": "other_name", "custom_fields": [ { "id": "836e4449-bc57-4b65-b62e-bf531e2499ae", "board_id": "b94a4f68-bcb2-4bcb-b1e0-dcc59d87080f", "name": "user field (card)", "type": "users", "scope": "card", "options": { "multiple": false, "values": [ { "user_id": "57fa913e-eff2-459f-8b8d-5cbe48613135" } ] }, "priority": 1, "created_at": "2024-06-24T10:02:48Z", "updated_at": "2024-06-24T14:40:47Z" }, { "id": "e01992aa-194c-4c4f-ab7a-c2a7cdf2f728", "board_id": "b94a4f68-bcb2-4bcb-b1e0-dcc59d87080f", "name": "users field (card)", "type": "users", "scope": "card", "options": { "multiple": true, "values": [ { "fullname": "Quentin Correia", "user_id": "57fa913e-eff2-459f-8b8d-5cbe48613135", "avatar": "https://fs.test.mostwanted.io/api/v1/project/42a0b7c5-3b9b-4755-9e92-54bdd3360b98/file/0340e241-c054-43ba-938c-31a7e845a80a?s=FpF2GkJd&token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczovL2ZzLnRlc3QubW9zdHdhbnRlZC5pby8iLCJzdWIiOiJ2cGxhbi1kZXYtcmVhZCIsImlhdCI6MTcxOTIxMzU2OCwibmJmIjoxNzE5MjEzNTY4LCJqdGkiOiI5ZjMwNDM3MC05ZjgwLTRkNmEtOTY4NC1jMDY3NDVjNDE5NTEifQ.VcgQyT516euaO3h_Zf-FPH1fsoY5bbcciWAUZOJU42M" } ] }, "priority": 1, "created_at": "2024-06-24T10:02:48Z", "updated_at": "2024-06-24T13:36:52Z" }, { "id": "909b8ded-cb3f-495f-8eaa-d1712aa21a03", "board_id": "b94a4f68-bcb2-4bcb-b1e0-dcc59d87080f", "name": "users field (collection)", "type": "users", "scope": "collection", "options": { "multiple": true, "values": [ { "fullname": "Quentin Correia", "user_id": "57fa913e-eff2-459f-8b8d-5cbe48613135", "avatar": "https://fs.test.mostwanted.io/api/v1/project/42a0b7c5-3b9b-4755-9e92-54bdd3360b98/file/0340e241-c054-43ba-938c-31a7e845a80a?s=FpF2GkJd&token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczovL2ZzLnRlc3QubW9zdHdhbnRlZC5pby8iLCJzdWIiOiJ2cGxhbi1kZXYtcmVhZCIsImlhdCI6MTcxOTIxMzU2OCwibmJmIjoxNzE5MjEzNTY4LCJqdGkiOiI5ZjMwNDM3MC05ZjgwLTRkNmEtOTY4NC1jMDY3NDVjNDE5NTEifQ.VcgQyT516euaO3h_Zf-FPH1fsoY5bbcciWAUZOJU42M" } ] }, "priority": 2, "created_at": "2024-06-24T10:02:48Z", "updated_at": "2024-06-24T13:36:52Z" }, { "id": "9522c642-2a9a-4d5e-868e-2be9c2d2f28d", "board_id": "b94a4f68-bcb2-4bcb-b1e0-dcc59d87080f", "name": "user field (collection)", "type": "users", "scope": "collection", "options": { "multiple": false, "values": [ { "fullname": "Quentin Correia", "user_id": "57fa913e-eff2-459f-8b8d-5cbe48613135", "avatar": "https://fs.test.mostwanted.io/api/v1/project/42a0b7c5-3b9b-4755-9e92-54bdd3360b98/file/0340e241-c054-43ba-938c-31a7e845a80a?s=FpF2GkJd&token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczovL2ZzLnRlc3QubW9zdHdhbnRlZC5pby8iLCJzdWIiOiJ2cGxhbi1kZXYtcmVhZCIsImlhdCI6MTcxOTIxMzU2OCwibmJmIjoxNzE5MjEzNTY4LCJqdGkiOiI5ZjMwNDM3MC05ZjgwLTRkNmEtOTY4NC1jMDY3NDVjNDE5NTEifQ.VcgQyT516euaO3h_Zf-FPH1fsoY5bbcciWAUZOJU42M" } ] }, "priority": 2, "created_at": "2024-06-24T10:02:48Z", "updated_at": "2024-06-24T13:36:52Z" } ] } ``` -------------------------------- ### Create Activity Source: https://docs.api.vplan.com/llms.txt Create a new activity and store it. ```APIDOC ## Create Activity ### Description Create a new Activity and store it. ### Method POST ### Endpoint /activities ### Parameters #### Request Body - **name** (string) - Required - The name of the activity. - **stageId** (string) - Required - The ID of the stage this activity belongs to. ``` -------------------------------- ### GET /schedule Source: https://docs.api.vplan.com/retrieve-schedule-list-3589197e0 Retrieves a paginated list of schedules. ```APIDOC ## GET /schedule ### Description Retrieves a list of schedules with pagination capabilities. ### Method GET ### Endpoint /schedule ### Query Parameters - **limit** (integer) - Optional - Max amount of items fetched. Defaults to 100, maximum 1000. - **offset** (integer) - Optional - Offset for pagination. Defaults to 0. ### Response #### Success Response (200) - **count** (integer) - Total amount of items. - **limit** (integer) - Max amount of items fetched. - **offset** (integer) - Offset for pagination. - **data** (array) - Array of schedule objects. - **id** (string) - Unique identifier. - **date** (string) - Date of the schedule. - **hours_available** (number) - Hours available. - **hours_work** (number) - Hours worked. - **hours_leave** (number) - Hours on leave. - **hours_absence** (number) - Hours of absence. - **resource_id** (string) - Unique identifier of the Resource. - **created_at** (string) - Date and time of creation. - **updated_at** (string) - Date and time of last update. ### Response Example ```json { "count": 1, "limit": 100, "offset": 0, "data": [ { "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef", "date": "2024-01-01", "hours_available": 8, "hours_work": 7.5, "hours_leave": 0.5, "hours_absence": 0, "resource_id": "f0e9d8c7-b6a5-4321-0987-fedcba098765", "created_at": "2024-04-11T10:22:15Z", "updated_at": "2024-04-11T10:22:15Z" } ] } ``` ``` -------------------------------- ### Get Schedule Source: https://docs.api.vplan.com/retrieve-schedule-year-3589198e0 Retrieves a list of schedule entries, potentially with pagination. ```APIDOC ## GET /schedule ### Description Retrieves a list of schedule entries. Supports pagination via `limit` and `offset` query parameters. ### Method GET ### Endpoint /schedule ### Query Parameters - **limit** (integer) - Optional - Max amount of items fetched. Default is 100, maximum is 1000. - **offset** (integer) - Optional - Offset for pagination. Default is 0. ### Response #### Success Response (200) - **count** (integer) - Total amount of items. - **limit** (integer) - Max amount of items fetched. - **offset** (integer) - Offset for pagination. - **data** (array) - Array of schedule objects. #### Response Example ```json { "count": 1, "limit": 100, "offset": 0, "data": [ { "id": "string (uuid)", "date": "string (date)", "hours_available": "number (double)", "hours_work": "number (double)", "hours_leave": "number (double)", "hours_absence": "number (double)", "resource_id": "string (uuid)", "created_at": "string (date-time)", "updated_at": "string (date-time)" } ] } ``` ``` -------------------------------- ### Create Board Source: https://docs.api.vplan.com/remove-single-card-3589222e0 Creates a new board. ```APIDOC ## Create Board ### Description Creates a new board. ### Method POST ### Endpoint /boards ``` -------------------------------- ### Get Card Checklists Source: https://docs.api.vplan.com/create-new-card-checklist-3589242e0 Retrieves all checklists associated with a specific card. ```APIDOC ## GET /cards/{cardId}/checklists ### Description Retrieves a list of all checklists for a given card. ### Method GET ### Endpoint /cards/{cardId}/checklists ### Parameters #### Path Parameters - **cardId** (string) - Required - The unique identifier of the card. ### Response #### Success Response (200 OK) - **checklists** (array) - A list of checklist objects. - Each checklist object contains: - **id** (string) - Unique identifier. - **name** (string) - Name of the checklist. - **editable** (boolean) - Indicates if the checklist is editable. - **position** (integer) - Position of the checklist. - **items** (array) - List of checklist items. - **collection_id** (string) - ID of the collection. - **card_id** (string) - ID of the card. - **created_at** (string) - Timestamp of creation. #### Response Example ```json { "checklists": [ { "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef", "name": "Checklist 1", "editable": true, "position": 0, "items": [], "collection_id": "f0e9d8c7-b6a5-4321-0987-654321fedcba", "card_id": "1a2b3c4d-5e6f-7890-1234-567890abcdef", "created_at": "2023-10-27T10:00:00Z" } ] } ``` ```