Only registered user can perform this action
Authentication - string - required
Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"
{
"id": 14,
"email": "kruchina.vadim@gmail.com",
"first_name": "Vadim",
"last_name": "Kruchina",
"role_in_organization": "Role",
"state": "CA",
"city": "Los Angeles",
"avatar_image": "https://gipper-college-logos-development.s3.amazonaws.com/s3_key",
"enable_content_request": true,
"payed_credit_card": false,
"fieldhouse_user": false,
"role": "super_admin",
"stripe_admin": true,
"organization_role": null,
"custom_organization_role": null,
"auth_token": "eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxNCwiZXhwIjoxNjU5MjU3Nzk1fQ.dxcqT4_SighZdUUmIiFU4b-_1S9SEj6xf_OSgxOGo1Y",
"team_exists": true,
"can_use_site": true,
"invites_count": 0,
"need_update_organization_type": false,
"newsletters_enabled": true (NOTE: added 19/10/23),
"mode": "light" (NOTE: added 22/10/24),
"workspace_role": {
"id": 1,
"name": "owner"
},
"workspace": {
"id": 1,
"name": "Scrum Launch",
"plan": [
"Basic"
],
"subscribed": true,
"trial_type": null,
"trial_status": ["in_progress", "upgrated", "expired"],
"trial_type_expired_date": "2024-03-08T14:02:30.698Z" (NOTE: added 26/02/24),
"organization_type": "["Public High School", "Private High School", "College/University", "Club/Youth Sports", "Other/Not Listed"]",
"custom_organization_type": "type",
"custom_tag_ids": [],
"available_users_count": 2,
"can_use_video": false,
"can_use_remove_bg": false,
"can_add_new_users": true,
"can_invite_users_count": 1,
"owner": {
"id": 1,
"email": "kruchina.vadim@gmail.com",
"full_name": "Vadym Kruchyna"
}
},
"payment_sources": [
{
"id": 1,
"last_4": "4242",
"expiration_month": 3,
"expiration_year": 2023
},
{
"id": 2,
"last_4": "4242",
"expiration_month": 3,
"expiration_year": 2023
}
],
"user_notifications": {
"team_admin": [
{
"id": 1,
"notification": {
"title": "Heads Up! You have been added to a new team",
"body": "<p>Your workspace member: kruchina.vadim@gmail.com has left your workspace.</p><p>This user was the admin of the team: MyTeam</p><p>To prevent the team from being removed, you have been added to this team and have been appointed as the team admin. If you do not wish to be a part of this team, please visit the team, appoint a new team admin, and leave the team.</p>",
"link": {
"text": "Go to Teams",
"path": "/teams"
}
}
},
...
],
invites: [
{
"id": 2,
"notification_data": {
"sender_name": "Vadim Kruchina",
"workspace_name": "Scrum Launch",
"invite_date": "2024-11-12T15:47:17.699Z",
"sender_avatar_image_link": "https://gipper-college-logos-development.s3.amazonaws.com/s3_key"
},
"invite_id": 20
},
...
]
},
"hidden_notifications": [],
"life_token": 59.98 (NOTE: Added 20/12/23)
}
Only registered user can perform this action
Authentication - string - required
Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"
{
"user": {
"email": "kruchina.vadim@gmail.com",
"first_name": "Vadim",
"last_name": "Kruchina",
"role_in_organization": "Role",
"state": "CA",
"city": "Los Angeles",
"avatar_image": "s3_key",
"current_password": "CURRENT_PASSWORD",
"password": "NEW_PASSWORD",
"password_confirmation": "NEW_PASSWORD",
"mode": "light",
"workspace_attributes": {
"id": 1,
"name": "Scrum Launch",
"organization_type": "Club/Youth Sports"
}
}
}
{
"id": 14,
"email": "kruchina.vadim@gmail.com",
"first_name": "Vadim",
"last_name": "Kruchina",
"role_in_organization": "Role",
"state": "CA",
"city": "Los Angeles",
"avatar_image": "https://gipper-college-logos-development.s3.amazonaws.com/s3_key",
"enable_content_request": true,
"payed_credit_card": false,
"fieldhouse_user": false,
"role": "super_admin",
"stripe_admin": true,
"auth_token": "eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxNCwiZXhwIjoxNjU5MjU3Nzk1fQ.dxcqT4_SighZdUUmIiFU4b-_1S9SEj6xf_OSgxOGo1Y",
"team_exists": true,
"can_use_site": true,
"workspace_role": {
"id": 1,
"name": "owner"
},
"workspace": {
"id": 1,
"name": "updated2",
"trial_type": "Two-week",
"trial_status": "in_progress",
"organization_type": "["Public High School", "Private High School", "College/University", "Club/Youth Sports", "Other/Not Listed"]",
"custom_organization_type": "CUSTOM_TYPE",
"plan": [
"Premier"
],
"subscribed": false
},
"payment_sources": [
{
"id": 1,
"last_4": "4242",
"expiration_month": 3,
"expiration_year": 2023
},
{
"id": 2,
"last_4": "4242",
"expiration_month": 3,
"expiration_year": 2023
}
],
"user_notifications": {
"team_admin": [
{
"id": 1,
"notification": {
"title": "Heads Up! You have been added to a new team",
"body": "<p>Your workspace member: kruchina.vadim@gmail.com has left your workspace.</p><p>This user was the admin of the team: MyTeam</p><p>To prevent the team from being removed, you have been added to this team and have been appointed as the team admin. If you do not wish to be a part of this team, please visit the team, appoint a new team admin, and leave the team.</p>",
"link": {
"text": "Go to Teams",
"path": "/teams"
}
}
},
...
],
invites: [
{
"id": 2,
"notification": {
body: "<p>Vadym Kruchyna has invited you to join the Scrum Launch workspace</p>"
}
},
...
]
},
"hidden_notifications": []
}
| Param name | Description |
|---|---|
|
user
required |
Validations:
|
|
user[email]
optional |
Validations:
|
|
user[first_name]
optional |
Validations:
|
|
user[last_name]
optional |
Validations:
|
|
user[role_in_organization]
optional |
Validations:
|
|
user[state]
optional |
Validations:
|
|
user[city]
optional |
Validations:
|
|
user[current_password]
optional |
Validations:
|
|
user[password]
optional |
Validations:
|
|
user[password_confirmation]
optional |
Validations:
|
|
user[plan_interest]
optional |
This property indicates what plan the prospect attempted to purchase when they abandoned their cart Validations:
|
|
user[platform_plan]
optional |
Validations:
|
|
user[abandoned_cart_date]
optional |
This is the date the contact exited the paid flow prior to completing payment. Validations:
|
|
user[purchase_date]
optional |
This is the date the user purchases a paid plan Validations:
|
|
user[po_request_date]
optional |
The date the user requests a PO invoice Validations:
|
|
user[organization_role]
optional |
Validations:
|
|
user[custom_organization_role]
optional |
Validations:
|
|
user[how_did_you_know_about_us]
optional |
Validations:
|
|
user[completed_user]
optional |
only when user created from stripe completed registration Validations:
|
|
user[walkthrough_seen]
optional |
Validations:
|
|
user[mode]
optional |
Validations:
|
|
user[workspace_attributes]
optional |
Validations:
|
|
user[workspace_attributes][id]
required |
Validations:
|
|
user[workspace_attributes][name]
optional |
Validations:
|
|
user[workspace_attributes][organization_type]
optional |
Validations:
|
|
user[workspace_attributes][custom_organization_type]
optional |
Validations:
|