vPlan
  1. Me
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
          GET
    • 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
        • 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. Me

Retrieve information about current authentication

GET
/me
Me
Show information about user, authentication details and customer environment for the authentication that is used.

Request

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

Responses

🟢200Ok
application/json
Body
optional
One of
type
string 
required
environment
object 
required
host
object 
required
settings
array [object {3}] 
required
features
array[string]
required
board_permission_set
object 
required
api-key
object 
required
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",
    "infix": "ullamco tempor",
    "fullname": "Anita Howe",
    "gender": "name.sex",
    "email": "Edd94@hotmail.com",
    "mobile": "792-962-0857 x7068",
    "avatar": null,
    "avatar_checksum": null,
    "avatar_signature": null,
    "about": null,
    "date_of_birth": null,
    "role": "quis sed mollit",
    "card_visibility": "ut culpa",
    "language": "aliquip incididunt quis tempor",
    "timezone": "Asia/Magadan",
    "notify_own_changes": false,
    "mfa_enabled": false,
    "nps_counter": 69440049,
    "archived_at": "2024-04-14T15:39:32.635Z",
    "created_at": "2024-04-15T09:16:32.845Z",
    "updated_at": "2024-04-14T10:51:00.380Z",
    "username": "Isadore86"
  },
  "show_nps": false,
  "permissions": [
    "fugiat non nostrud"
  ],
  "organizations": [
    {
      "id": "labore Lorem Excepteur aliqua voluptate",
      "name": "iure consequatur molestiae",
      "current": false
    }
  ],
  "identity_hash": "anim deserunt"
}
🟠401Not Logged In
Modified at 2025-04-22 11:37:34
Previous
Me
Next
Errors
Built with