1. User
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
        • Checklist
          • List Checklist
          • Create Checklist
          • Retrieve Checklist
          • Update Checklist
          • Remove Checklist
        • 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
        • Create New Resource
        • Retrieve Single Resource
        • Update Single Resource
        • Remove Single Resource
      • Group
        • Retrieve Group List
        • Create New Group
        • Retrieve Single Group
        • Update Single Group
        • Remove Single Group
      • User
        • Invite User
          POST
        • Retrieve User List
          GET
        • Retrieve Single User
          GET
        • Update Single User
          PUT
      • 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. User

Invite User

POST
/user
Invite a user

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
Body Params application/json

Example
{
    "email": "Humberto_Schroeder@hotmail.com",
    "role": "organiser",
    "card_visibility": "all",
    "language": "en",
    "resource": {
        "id": "01e22839-4e1a-4bb0-8f00-b7bca20618c4"
    }
}

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 'https://api.vplan.com/v1/user' \
--header 'x-api-key: <api-key>' \
--header 'x-api-env: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "Humberto_Schroeder@hotmail.com",
    "role": "organiser",
    "card_visibility": "all",
    "language": "en",
    "resource": {
        "id": "01e22839-4e1a-4bb0-8f00-b7bca20618c4"
    }
}'

Responses

🟢201Created
application/json
Bodyapplication/json

Example
{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "idp_id": "string",
    "status": "invited",
    "invite_id": "string",
    "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
    "infix": "string",
    "email": "user@example.com",
    "avatar": "http://example.com",
    "avatar_checksum": "string",
    "avatar_signature": "string",
    "role": "admin",
    "card_visibility": "all",
    "language": "nl",
    "notify_own_changes": true,
    "mfa_enabled": true,
    "external_ref": "fb1033a2ed70",
    "created_at": "2024-04-11T10:22:15Z",
    "updated_at": "2024-04-11T10:22:15Z",
    "archived_at": "2021-07-06T11:24:35Z",
    "fullname": "string",
    "lastname": "string",
    "firstname": "string",
    "username": "user@example.com"
}
🟠404Not Found
🟠401Not Logged In
Modified at 2025-10-30 09:44:22
Previous
User
Next
Retrieve User List
Built with