vPlan
  1. Endpoints
  2. Card Data
  3. Card
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
        • 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
        • Update Single Collection
        • Remove Single Collection
        • Move Collection to Backlog
        • Move Collection to Board
      • Card
        • Custom Field
          • Update Custom Field By Name
          • Delete Custom Field By Name
        • Retrieve Card List
          GET
        • All Cards List
          GET
        • Create New Card
          POST
        • Retrieve Single Card
          GET
        • Update Single Card
          PUT
        • Remove Single Card
          DELETE
        • Split Card
          PUT
      • 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. Endpoints
  2. Card Data
  3. Card

Retrieve Single Card

GET
/collection/{collection_id}/card/{card_id}
Card
Retrieve a single Card from this collection

Request

Path Params
collection_id
string 
required
card_id
string 
required
Query Params
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
include
array[string]
optional
object(s) included in the dataset, see eager loading for more info.
Possible options are:
time_tracking_total
resource_type_count - count of linked resources by resource type
resource_type_time - sum of linked activities by resource type
Allowed values:
time_tracking_totalresource_type_countresource_type_time
with
array[string]
optional
object(s) included in the dataset, see eager loading for more info.
Possible options are:
activities
collection
labels
resources - assigned to the card
stage
statuses
time - total time of the linked activities
time_tracking
relations
Allowed values:
activitiescollectionlabelsresourcesstagestatustimetime_trackingrelations
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/collection//card/' \
--header 'x-api-key;' \
--header 'x-api-env;'

Responses

🟢200Ok
application/json
Body
id
string <uuid>
read-onlyoptional
Unique identifier
name
string 
optional
Name specific for a Card
NOTE
Collection has a name global for all cards, however a Card can have a specific name different from the rest.
Update the Collection name to update it for every Card.
Example:
Painting Order 10199
description
string 
optional
Description specific for a Card
NOTE
Collection has a description global for all cards, however a Card can have a specific description different from the rest.
Update the Collection description to update it for every Card.
Example:
Painting 3x Chair Lissabon Red
start_date
string <date> | null 
optional
Default:
2020-01-02
start_time
string <time> | null 
optional
Default:
15:00
end_date
string <date> | null 
optional
Default:
2020-01-02
end_time
string <time> | null 
optional
Default:
15:00
rank
string 
read-onlyoptional
Alphanumeric representation of the position
Default:
aaa
position
integer 
read-onlyoptional
Position of the card in a day
days_diff
integer 
read-onlyoptional
days_active
integer 
read-onlyoptional
locked
boolean 
read-onlyoptional
time_tracking_running
boolean 
read-onlyoptional
custom_fields
array[object (CustomField) {13}] 
required
id
string <uuid>
read-onlyoptional
Unique identifier
name
string 
optional
Name of the field
Example:
Weight
type
enum<string> 
optional
Allowed values:
textnumberdatecheckboxemaillinkphonelistselectaddressdrawingtextareausers
Default:
text
Example:
number
scope
enum<string> 
optional
Allowed values:
collectioncard
priority
integer 
optional
Priority of the custom field in which the fields are ordered in the frontend
Example:
0
value
string  | integer  | boolean  | array  | number  | object  | null 
optional
drawing_id
string <uuid>
optional
components
object (CustomFieldOptionsAddress) 
optional
list
array [object {3}] 
optional
selected
object 
optional
options
optional
Extra settings for number, select or list types
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
date
string <date> | null 
deprecated
Default:
2020-01-02
start
string <date> | null 
deprecated
Default:
2020-01-02
end
string <date> | null 
deprecated
Default:
2020-01-02
time
integer 
deprecated
Duration of the card in minutes
Example:
120
card_recurring_id
string <uuid> | null 
optional
parent_card_id
string <uuid> | null 
optional
collection_id
string <uuid>
required
Unique identifier of the Collection
status_id
string <uuid>
required
Unique identifier of the Status
stage_id
string <uuid>
required
Unique identifier of the Stage
external_ref
string  | null 
read-onlyoptional
Third-party reference of the object, for informational purposes only
Example:
fb1033a2ed70
completed_at
string <date-time> | null 
optional
created_at
string <date-time>
read-onlyrequired
Date and time of creation
Example:
2024-04-11T10:22:15Z
updated_at
string <date-time>
read-onlyrequired
Date and time of last update
Example:
2024-04-11T10:22:15Z
Example
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "Painting Order 10199",
  "description": "Painting 3x Chair Lissabon Red",
  "start_date": "2020-01-02",
  "start_time": "15:00",
  "end_date": "2020-01-02",
  "end_time": "15:00",
  "rank": "aaa",
  "position": 0,
  "days_diff": 0,
  "days_active": 0,
  "locked": true,
  "time_tracking_running": true,
  "custom_fields": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "Weight",
      "type": "text",
      "scope": "collection",
      "priority": 0,
      "value": "string",
      "drawing_id": "19ba6f6f-3365-4d74-bdc5-b3df4072c0ab",
      "components": {
        "latitude": 52.3156048,
        "longitude": 6.496432,
        "country": "Netherlands",
        "city": "Rijssen",
        "postal_code": "7462TB",
        "street1": "Hogepad 83",
        "street2": "Second floor"
      },
      "list": [
        {
          "name": "string",
          "value": "string",
          "color": "transparent"
        }
      ],
      "selected": {
        "name": "string",
        "value": "string",
        "color": ""
      },
      "options": {
        "unit": "kg",
        "align": "left",
        "decimals": 2
      },
      "created_at": "2024-04-11T10:22:15Z",
      "updated_at": "2024-04-11T10:22:15Z"
    }
  ],
  "date": "2020-01-02",
  "start": "2020-01-02",
  "end": "2020-01-02",
  "time": 120,
  "card_recurring_id": "106de719-5cc0-4af9-bc80-777744f7e20c",
  "parent_card_id": "37909c19-1675-4aa9-a5ad-e2a7cefd2529",
  "collection_id": "4bdef85c-3f50-4006-a713-2350da665f80",
  "status_id": "4e949624-bc0f-439e-a9f2-25a23938812c",
  "stage_id": "f38d2b9c-0a0a-4eea-91a8-e974413bb670",
  "external_ref": "fb1033a2ed70",
  "completed_at": "2019-08-24T14:15:22Z",
  "created_at": "2024-04-11T10:22:15Z",
  "updated_at": "2024-04-11T10:22:15Z"
}
🟠404Not Found
🟠401Not Logged In
Modified at 2024-11-06 13:50:52
Previous
Create New Card
Next
Update Single Card
Built with