get

Description

Returns data about the current user.

URL

https://api.skriv.com/v1/user/get

Response

FieldTypeDescription
idintUser ID
dateCreationdatetimeCreation date
dateTrialEnddatetimeTrial period end date
emailstringEmail address
namestringUser name
langenumLanguage: 'en' or 'fr'
firstWeekdayenumFirst day of week: 'monday' or 'sunday'
dateFormatenumDate format (see below)
timeFormatenumTime format (see below)
isValidbooltrue if the account was validated (the user connected), false otherwise
isActivebooltrue if the account was activated (the user entered her name), false otherwise
creatorIdintID of the user who created this user. null if the user created her account by herself.
creatorNamestringName of the user who created this user. null if the user created her account by herself.
isTrialEndedbooltrue if the trial period is over, false otherwise
hasSubscriptionbooltrue if the user has a valid subscription, false otherwise
subscriptionTypestringSubscription type: 'pro', 'business' or 'enterprise'
organizationsarrayList of organizations (see below)

Date format

ValueExample
%d/%m/%Y14/07/2019
%m/%d/%Y07/14/2019
%d.%m.%Y14.07.2019
%Y-%m-%d2019-07-14

Time format

ValueExample
%H:%M13:04
%I:%M %P01:04 pm

Organization

FieldTypeDescription
idintOrganization ID
namestringOrganization name
dateCreationdatetimeCreation date
lastActivitydatetimeDate of the last access of the user on this organization
colorenum'red', 'pink', 'purple', 'deeppurple', 'indigo', 'blue', 'lightblue', 'cyan', 'teal', 'green', 'lightgreen', 'lime', 'yellow', 'amber', 'orange', 'deeporange', 'brown', 'gray', 'bluegray', 'black'
creatorIdintCreator ID
creatorNamestringCreator name
invitationUserIdintID of the user who invited the current user to this organization, or null if the current user is the organization's creator
invitationUserNamestringName of the user who invited the current user to this organization, or null if the current user is the organization's creator
dateInvitationdatetimeDate of invitation, or null if the current user is the organization's creator
dateInvitationAccepteddatetimeDate of when the invitation was accepted
isAdminbooltrue is the current user has administrator rights on this organization, false otherwise