vPlan
  1. Resource
vPlan
  • General
    • Structure
    • Synchronize Data
    • Pagination
    • Sorting
    • Filtering
    • Show & Hide
    • Eager Loading
    • Deep Insertion
    • Deprecated
    • External Reference
    • Rate Limits
    • Authentication
      • Authentication
        • Get authorization
        • Token Exchange
      • Me
        • Retrieve information about current authentication
    • Errors
      • Empty values in created object
      • Memory Exhausted
      • Report an issue
      • Service Unavailable
      • Retrieve Api Messages
  • Endpoints
    • Base Data
      • Board
        • Label
        • Status
        • Capacity
          • Capacity Stage
          • Capacity Resource Type Stage
          • Capacity Resource
          • Capacity Group
        • View
          • Create New BoardView
        • List Boards
        • Create Board
        • Retrieve Board
        • Update Board
        • Remove Board
      • Stage
        • List Stages
        • Create Stage
        • Retrieve Stage
        • Update Stage
        • Remove Stage
      • Activity
        • List Activities
        • Create Activity
        • Retrieve Activity
        • Update Activity
        • Remove Activity
      • Resource
        • Schedule
          • Bulk update schedule
          • Retrieve Schedule List
          • Retrieve Schedule Year
          • Retrieve Schedule Month
          • Schedule Retrieve Day
        • Schedule Deviation
          • Retrieve Deviation List
          • Create New Schedule Deviation
          • Retrieve Single Schedule Deviation
          • Update Single Schedule Deviation
          • Remove Single Schedule Deviation
        • Retrieve Resource List
          GET
        • Create New Resource
          POST
        • Retrieve Single Resource
          GET
        • Update Single Resource
          PUT
        • Remove Single Resource
          DELETE
      • Group
        • Retrieve Group List
        • Create New Group
        • Retrieve Single Group
        • Update Single Group
        • Remove Single Group
      • User
        • Invite User
        • Retrieve User List
        • Retrieve Single User
        • Update Single User
      • Space
        • Retrieve Space List
        • Create New Space
        • Retrieve Single Space
        • Update Single Space
        • Remove Single Space
    • Card Data
      • Collection
        • Custom Fields
          • Update Custom Field By Name
          • Delete Custom Field By Name
        • Retrieve Collection List
        • Create New Collection
        • Retrieve Single Collection
        • Update Single Collection
        • Remove Single Collection
        • Move Collection to Board
        • Move Collection to Backlog
      • Card
        • Custom Field
          • Update Custom Field By Name
          • Delete Custom Field By Name
        • Retrieve Card List
        • Create New Card
        • Retrieve Single Card
        • Update Single Card
        • Remove Single Card
        • Split Card
        • All Cards List
      • Attachment
        • Retrieve Attachment List
        • Upload New Attachment
        • Add New Attachment Link
        • Retrieve Single Attachment
        • Remove Single Attachment
      • Comment
        • Retrieve Comment List
        • Create New Comment
        • Retrieve Single Comment
        • Update Single Comment
        • Remove Single Comment
      • Checklist
        • Collection
          • Retrieve Collection Checklist List
          • Create New Collection Checklist
          • Retrieve Single Collection Checklist
          • Update Single Collection Checklist
          • Remove Single Collection Checklist
        • Card
          • Retrieve Card Checklist List
          • Create New Card Checklist
          • Retrieve Single Card Checklist
          • Update Single Card Checklist
          • Remove Single Card Checklist
      • Time Tracking
        • Retrieve TimeTracking List
        • Create New TimeTracking
        • Retrieve Single TimeTracking
        • Update Single TimeTracking
        • Remove Single TimeTracking
        • Export TimeTracking
      • Relations between cards
        • Retrieve CardRelation List
        • Create New CardRelation
        • Retrieve Single CardRelation
        • Remove Single CardRelation
      • Card Relation
    • Order Data
      • Address
      • Order
        • Retrieve Order List
        • Create New Order
        • Retrieve Single Order
        • Update Single Order
        • Remove Single Order
      • Row
        • Retrieve OrderRow List
        • Create New OrderRow
        • Retrieve Single OrderRow
        • Update Single OrderRow
        • Remove Single OrderRow
      • Item
        • Retrieve Item List
        • Create New Item
        • Retrieve Single Item
        • Update Single Item
        • Remove Single Item
      • Project
        • Retrieve Project List
        • Create New Project
        • Retrieve Single Project
        • Update Single Project
        • Remove Single Project
      • Relation
        • Retrieve Relation List
        • Create New Relation
        • Retrieve Single Relation
        • Update Single Relation
        • Remove Single Relation
      • Warehouse
        • Retrieve Warehouse List
        • Create New Warehouse
        • Retrieve Single Warehouse
        • Update Single Warehouse
        • Remove Single Warehouse
    • Webhook
      • Payload send to webhook url
        • Normal Object
        • Nested Object
        • Nested Object with Pivot
      • Retrieve Webhook List
      • Create New Webhook
      • Retrieve Single Webhook
      • Update Single Webhook
      • Remove Single Webhook
  1. Resource

Retrieve Resource List

GET
/resource
Retrieve the Resource List

Request

Authorization
API Key
Add parameter in header
x-api-key
Example:
x-api-key: ********************
API Key
Add parameter in header
x-api-env
Example:
x-api-env: ********************
or
Query Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.vplan.com/v1/resource?with&archived=' \
--header 'x-api-key: <api-key>' \
--header 'x-api-env: <api-key>'

Responses

🟢200Ok
application/json
Body

Example
{
    "count": 12,
    "limit": 100,
    "offset": 0,
    "data": [
        {
            "id": "2ce36ba2-0957-4c28-a02c-7682f8ce5927",
            "type": "employee",
            "name": "Royce Mathews",
            "description": "Employee",
            "external_ref": null,
            "transaction": null,
            "start_date": null,
            "end_date": null,
            "avatar": null,
            "workdays": {
                "1": 8,
                "2": 8,
                "3": 8,
                "4": 8,
                "5": 8,
                "6": 0,
                "7": 0
            },
            "integration_schedule": false,
            "color_hex": "#5652e0",
            "archived_at": null,
            "created_at": "2025-07-16T07:22:44Z",
            "updated_at": "2025-07-30T08:42:27Z"
        },
        {
            "id": "3f41bfc9-4fb3-4563-8b72-316430e6959a",
            "type": "employee",
            "name": "Jimmie Moss",
            "description": "CEO",
            "external_ref": null,
            "transaction": null,
            "start_date": null,
            "end_date": null,
            "avatar": null,
            "workdays": {
                "1": 8,
                "2": 8,
                "3": 8,
                "4": 8,
                "5": 8,
                "6": 0,
                "7": 0
            },
            "integration_schedule": false,
            "color_hex": "#e052c4",
            "archived_at": null,
            "created_at": "2025-07-16T07:20:15Z",
            "updated_at": "2025-07-30T08:42:02Z"
        },
        {
            "id": "425cf356-fea0-4b22-b155-2f2aef9263df",
            "type": "employee",
            "name": "Burt Horton",
            "description": "Technician",
            "external_ref": null,
            "transaction": null,
            "start_date": null,
            "end_date": null,
            "avatar": null,
            "workdays": {
                "1": 8,
                "2": 8,
                "3": 8,
                "4": 8,
                "5": 8,
                "6": 0,
                "7": 0
            },
            "integration_schedule": false,
            "color_hex": "#e0c452",
            "archived_at": null,
            "created_at": "2025-07-16T07:51:44Z",
            "updated_at": "2025-07-30T08:41:53Z"
        },
        {
            "id": "43494745-d93c-4154-beff-1b867294fcb9",
            "type": "employee",
            "name": "Susana Thompson",
            "description": "CFO",
            "external_ref": null,
            "transaction": null,
            "start_date": null,
            "end_date": null,
            "avatar": null,
            "workdays": {
                "1": 8,
                "2": 8,
                "3": 8,
                "4": 8,
                "5": 8,
                "6": 0,
                "7": 0
            },
            "integration_schedule": false,
            "color_hex": "#e08152",
            "archived_at": null,
            "created_at": "2025-07-16T07:21:45Z",
            "updated_at": "2025-07-30T08:42:44Z"
        },
        {
            "id": "4c93d429-138d-413b-8ee8-0580eeb4ed6b",
            "type": "machine",
            "name": "Packaging Machine",
            "description": "Type-1",
            "external_ref": null,
            "transaction": null,
            "start_date": null,
            "end_date": null,
            "avatar": null,
            "workdays": {
                "1": 12,
                "2": 12,
                "3": 12,
                "4": 12,
                "5": 12,
                "6": 0,
                "7": 0
            },
            "integration_schedule": false,
            "color_hex": "#e0dc52",
            "archived_at": null,
            "created_at": "2025-07-16T07:25:43Z",
            "updated_at": "2025-07-30T08:43:17Z"
        },
        {
            "id": "71e0b831-0574-4edc-a5c8-0a766b957a29",
            "type": "employee",
            "name": "Domingo Fischer",
            "description": "Technician",
            "external_ref": null,
            "transaction": null,
            "start_date": null,
            "end_date": null,
            "avatar": null,
            "workdays": {
                "1": 8,
                "2": 8,
                "3": 8,
                "4": 8,
                "5": 8,
                "6": 0,
                "7": 0
            },
            "integration_schedule": false,
            "color_hex": "#cd52e0",
            "archived_at": null,
            "created_at": "2025-07-16T07:51:06Z",
            "updated_at": "2025-07-30T08:43:30Z"
        },
        {
            "id": "8944f6d6-63b3-4068-9054-78c5b55ebfa2",
            "type": "employee",
            "name": "Brandon Weeks",
            "description": "CTO",
            "external_ref": null,
            "transaction": null,
            "start_date": null,
            "end_date": null,
            "avatar": null,
            "workdays": {
                "1": 8,
                "2": 8,
                "3": 0,
                "4": 8,
                "5": 8,
                "6": 0,
                "7": 0
            },
            "integration_schedule": false,
            "color_hex": "#b6e052",
            "archived_at": null,
            "created_at": "2025-07-16T07:21:25Z",
            "updated_at": "2025-07-30T08:41:44Z"
        },
        {
            "id": "89a55e72-7e18-4f67-856a-128a028495fa",
            "type": "employee",
            "name": "Monty Rocha",
            "description": "Employee",
            "external_ref": null,
            "transaction": null,
            "start_date": null,
            "end_date": null,
            "avatar": null,
            "workdays": {
                "1": 8,
                "2": 8,
                "3": 8,
                "4": 8,
                "5": 8,
                "6": 0,
                "7": 0
            },
            "integration_schedule": false,
            "color_hex": "#e05265",
            "archived_at": null,
            "created_at": "2025-07-16T07:22:30Z",
            "updated_at": "2025-07-30T08:42:10Z"
        },
        {
            "id": "900353bd-c432-462e-a63d-f054eebd7f8e",
            "type": "employee",
            "name": "Roxanne Sandoval",
            "description": "Technician",
            "external_ref": null,
            "transaction": null,
            "start_date": null,
            "end_date": null,
            "avatar": null,
            "workdays": {
                "1": 8,
                "2": 8,
                "3": 8,
                "4": 8,
                "5": 8,
                "6": 0,
                "7": 0
            },
            "integration_schedule": false,
            "color_hex": "#7352e0",
            "archived_at": null,
            "created_at": "2025-07-16T07:50:46Z",
            "updated_at": "2025-07-30T08:42:18Z"
        },
        {
            "id": "a9607cbd-41e8-4670-9a52-c8888c0adcb3",
            "type": "machine",
            "name": "Cutting Machine",
            "description": "Type-0",
            "external_ref": null,
            "transaction": null,
            "start_date": null,
            "end_date": null,
            "avatar": null,
            "workdays": {
                "1": 12,
                "2": 12,
                "3": 12,
                "4": 12,
                "5": 12,
                "6": 0,
                "7": 0
            },
            "integration_schedule": false,
            "color_hex": "#52dce0",
            "archived_at": null,
            "created_at": "2025-07-16T07:25:07Z",
            "updated_at": "2025-07-30T08:43:40Z"
        },
        {
            "id": "b5435fa1-fe14-4150-925d-14bf135dd856",
            "type": "employee",
            "name": "Andrea Hanson",
            "description": "CHO",
            "external_ref": null,
            "transaction": null,
            "start_date": null,
            "end_date": null,
            "avatar": null,
            "workdays": {
                "1": 8,
                "2": 8,
                "3": 4,
                "4": 4,
                "5": 4,
                "6": 0,
                "7": 0
            },
            "integration_schedule": false,
            "color_hex": "#ba52e0",
            "archived_at": null,
            "created_at": "2025-07-16T07:22:08Z",
            "updated_at": "2025-07-30T08:40:57Z"
        },
        {
            "id": "f8f21a51-550c-4e5f-91c3-a716664581ac",
            "type": "machine",
            "name": "Welding Machine",
            "description": "Type-2",
            "external_ref": null,
            "transaction": null,
            "start_date": null,
            "end_date": null,
            "avatar": null,
            "workdays": {
                "1": 12,
                "2": 12,
                "3": 12,
                "4": 12,
                "5": 12,
                "6": 0,
                "7": 0
            },
            "integration_schedule": false,
            "color_hex": "#52e086",
            "archived_at": null,
            "created_at": "2025-07-16T07:26:11Z",
            "updated_at": "2025-07-30T08:42:35Z"
        }
    ]
}
🟠404Not Found
🟠401Not Logged In
Modified at 2025-10-30 09:44:22
Previous
Remove Single Schedule Deviation
Next
Create New Resource
Built with