vPlan
  1. Errors
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
        GET
  • Endpoints
    • Base Data
      • Board
        • Label
        • Status
        • Capacity
          • Capacity Stage
          • Capacity Resource Type Stage
          • Capacity Resource
          • Capacity Group
        • Retrieve Board List
        • Create New Board
        • Retrieve Single Board
        • Update Single Board
        • Remove Single Board
      • Stage
        • Retrieve Stage List
        • Create New Stage
        • Retrieve Single Stage
        • Update Single Stage
        • Remove Single Stage
      • Activity
        • Retrieve Activity List
        • Create New Activity
        • Retrieve Single Activity
        • Update Single Activity
        • Remove Single Activity
      • Resource
        • Retrieve Resource List
        • Create New Resource
        • Retrieve Single Resource
        • Update Single Resource
        • Remove Single Resource
      • Schedule
        • Retrieve Schedule List
        • Retrieve Schedule Year
        • Retrieve Schedule Month
        • Schedule Retrieve Day
      • Group
        • Retrieve Group List
        • Create New Group
        • Retrieve Single Group
        • Update Single Group
        • Remove Single Group
      • User
        • Retrieve User List
        • Retrieve Single User
        • Update Single User
    • Card Data
      • Collection
        • Custom Fields
          • Update Custom Field By Name
          • Delete Custom Field By Name
        • Retrieve Collection List
        • Create New Collection
        • Retrieve Single Collection
        • Remove Single Collection
        • Move Collection to Backlog
        • Update Single Collection
        • Move Collection to Board
      • 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
    • 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
      • Retrieve Webhook List
      • Create New Webhook
      • Retrieve Single Webhook
      • Update Single Webhook
      • Remove Single Webhook
    • Payload send to webhook url
      • Normal Object
      • Nested Object
      • Nested Object with Pivot
  1. Errors

Retrieve Api Messages

GET
/api_message
Errors
The vPlan API is constantly improving, which means that today's endpoints and features could be replaced or removed in the future.
Where possible and appropriate, the API adds a deprecated header to the response.
The API also offers this endpoint to retrieve any messages or warnings recorded during third party requests.
Integrators are expected to review these messages regularly and act accordingly.

Request

Query Params
sort
string 
optional
field(s) for sorting the dataset, see sorting for more info
Example:
updated_at:desc,id
limit
integer 
optional
maximum number of records given, see pagination for more info
>= 1
Default:
100
Example:
50
offset
integer 
optional
the number of records to be skipped, see pagination for more info
>= 0
Default:
0
Example:
0
filter
string 
optional
used to filter the dataset, see filtering for more info
Example:
created_at:gt:2020-09-26,and,(id:not:starts_with:0000,or,id:contains:FFFF)
show
string 
optional
limit the response to show only specific properties, see show & hide for more info
Example:
id,updated_at
hide
string 
optional
hide properties from the response, see show & hide for more info
Example:
created_at,updated_at
Header Params
x-api-key
string 
required
Default:
{{api_key}}
x-api-env
string 
required
Default:
{{api_env}}

Request 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/api_message' \
--header 'x-api-key;' \
--header 'x-api-env;'

Responses

🟢200Ok
application/json
Body
count
integer <uint64>
required
Total amount of items
>= 0
Default:
1
limit
integer <uint64>
required
Max amount of items fetched
>= 0<= 1000
Default:
100
offset
integer <uint64>
required
Offset so items may be paginated
>= 0
Default:
0
data
array[object (ApiMessage) {9}] 
required
Items
id
string <uuid>
read-onlyoptional
Unique identifier
message
string 
optional
Full message with details
message_code
string 
optional
Code to categorize the message
log_level
enum<string> 
optional
Allowed values:
fatalerrorwarninginfo
method
enum<string> 
optional
Method which caused the message
Allowed values:
GETHEADPOSTPUTDELETECONNECTOPTIONSTRACEPATCH
Default:
GET
endpoint
string 
optional
Endpoint which caused the message
query_params
string 
optional
Quary parameters in JSON Format which caused the message
created_at
string <date-time>
read-onlyoptional
Date and time of creation
Example:
2024-04-11T10:22:15Z
updated_at
string <date-time>
read-onlyoptional
Date and time of last update
Example:
2024-04-11T10:22:15Z
Example
{
  "count": 1,
  "limit": 100,
  "offset": 0,
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "message": "string",
      "message_code": "string",
      "log_level": "fatal",
      "method": "GET",
      "endpoint": "string",
      "query_params": "string",
      "created_at": "2024-04-11T10:22:15Z",
      "updated_at": "2024-04-11T10:22:15Z"
    }
  ]
}
🟠401Not Logged In
Modified at 2025-04-22 11:37:36
Previous
Service Unavailable
Next
Endpoints
Built with