Skip to content
Askara API
/
User

Askara API (1.0.0)

Askara.ai open API

Languages
Servers
Production

https://api.askara.ai/

Contact

Operations

Document

Operations

Organization

Operations

Patient

Operations

User

Operations

Retrieve current user.

Request

Use this endpoint to retrieve the current user information.

curl -i -X GET \
  https://api.askara.ai/me

Responses

User resource

Body
uuidstring(uuid)

User unique identifier.

emailstring(email)required

User email address.

https://schema.org/email
createdAtstring(date-time)

User creation date.

updatedAtstring(date-time)

User update date.

firstNamestringrequired

User first name.

lastNamestringrequired

User last name.

genderstring or nullrequired

User gender.

Default "unknown"
Enum"female""male""unknown"null
Example: "unknown"
isVerifiedboolean

User email address verification status.

Default false
Example: false
phonestring or nullrequired

User phone number.

Example: "+33757590893"
rppsstring or null= 11 characters^(\d+)$

User RPPS number (France).

Example: "10101748050"
amstring or null= 9 characters^(\d+)$

User AM number (France).

Example: "394003552"
organizationsArray of objects(Organization-current_user.read_user.read_user.read_organization)

User organizations.

Response
{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "email": "user@example.com",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "firstName": "string",
  "lastName": "string",
  "gender": "unknown",
  "isVerified": false,
  "phone": "+33757590893",
  "rpps": "10101748050",
  "am": "394003552",
  "organizations": [
    { … }
  ]
}

Retrieve collection of users.

Request

Use this endpoint to retrieve the collection of user information.

Query
pageinteger

The collection page number

Default 1
itemsPerPageinteger[ 0 .. 100 ]

The number of items per page

Default 20
order[id]string
Default "asc"
Enum"asc""desc"
order[uuid]string
Default "asc"
Enum"asc""desc"
order[stripeCustomerId]string
Default "asc"
Enum"asc""desc"
order[email]string
Default "asc"
Enum"asc""desc"
order[trustedVersion]string
Default "asc"
Enum"asc""desc"
order[createdAt]string
Default "asc"
Enum"asc""desc"
order[updatedAt]string
Default "asc"
Enum"asc""desc"
order[lastLoginAt]string
Default "asc"
Enum"asc""desc"
order[lastSessionAt]string
Default "asc"
Enum"asc""desc"
order[banishedAt]string
Default "asc"
Enum"asc""desc"
order[twoFactorSmsEnabledAt]string
Default "asc"
Enum"asc""desc"
order[twoFactorEmailEnabledAt]string
Default "asc"
Enum"asc""desc"
order[twoFactorTotpEnabledAt]string
Default "asc"
Enum"asc""desc"
order[twoFactorGoogleEnabledAt]string
Default "asc"
Enum"asc""desc"
order[twoFactorBackupCodesEnabledAt]string
Default "asc"
Enum"asc""desc"
order[firstName]string
Default "asc"
Enum"asc""desc"
order[lastName]string
Default "asc"
Enum"asc""desc"
order[gender]string
Default "asc"
Enum"asc""desc"
order[isVerified]string
Default "asc"
Enum"asc""desc"
order[phone]string
Default "asc"
Enum"asc""desc"
order[rpps]string
Default "asc"
Enum"asc""desc"
order[am]string
Default "asc"
Enum"asc""desc"
order[language]string
Default "asc"
Enum"asc""desc"
order[timezone]string
Default "asc"
Enum"asc""desc"
order[languageSpoken]string
Default "asc"
Enum"asc""desc"
order[languageDocument]string
Default "asc"
Enum"asc""desc"
order[displayGodMode]string
Default "asc"
Enum"asc""desc"
searchstring

Global case-insensitive text search.

idinteger
id[]Array of integers
uuidstring
uuid[]Array of strings
stripeCustomerIdstring
stripeCustomerId[]Array of strings
emailstring
email[]Array of strings
totpSecretstring
totpSecret[]Array of strings
googleAuthenticatorSecretstring
googleAuthenticatorSecret[]Array of strings
authCodestring
authCode[]Array of strings
trustedVersioninteger
trustedVersion[]Array of integers
firstNamestring
lastNamestring
genderstring
gender[]Array of strings
isVerifiedboolean
isVerified[]Array of booleans
phonestring
phone[]Array of strings
rppsstring
rpps[]Array of strings
amstring
am[]Array of strings
studentStatusstring
studentStatus[]Array of strings
languagestring
language[]Array of strings
timezonestring
timezone[]Array of strings
languageSpokenstring
languageSpoken[]Array of strings
languageDocumentstring
languageDocument[]Array of strings
personalizationstring
personalization[]Array of strings
displayGodModeboolean
displayGodMode[]Array of booleans
createdAt[between]string
createdAt[gt]string
createdAt[gte]string
createdAt[lt]string
createdAt[lte]string
updatedAt[between]string
updatedAt[gt]string
updatedAt[gte]string
updatedAt[lt]string
updatedAt[lte]string
lastLoginAt[between]string
lastLoginAt[gt]string
lastLoginAt[gte]string
lastLoginAt[lt]string
lastLoginAt[lte]string
lastSessionAt[between]string
lastSessionAt[gt]string
lastSessionAt[gte]string
lastSessionAt[lt]string
lastSessionAt[lte]string
banishedAt[between]string
banishedAt[gt]string
banishedAt[gte]string
banishedAt[lt]string
banishedAt[lte]string
twoFactorSmsEnabledAt[between]string
twoFactorSmsEnabledAt[gt]string
twoFactorSmsEnabledAt[gte]string
twoFactorSmsEnabledAt[lt]string
twoFactorSmsEnabledAt[lte]string
twoFactorEmailEnabledAt[between]string
twoFactorEmailEnabledAt[gt]string
twoFactorEmailEnabledAt[gte]string
twoFactorEmailEnabledAt[lt]string
twoFactorEmailEnabledAt[lte]string
twoFactorTotpEnabledAt[between]string
twoFactorTotpEnabledAt[gt]string
twoFactorTotpEnabledAt[gte]string
twoFactorTotpEnabledAt[lt]string
twoFactorTotpEnabledAt[lte]string
twoFactorGoogleEnabledAt[between]string
twoFactorGoogleEnabledAt[gt]string
twoFactorGoogleEnabledAt[gte]string
twoFactorGoogleEnabledAt[lt]string
twoFactorGoogleEnabledAt[lte]string
twoFactorBackupCodesEnabledAt[between]string
twoFactorBackupCodesEnabledAt[gt]string
twoFactorBackupCodesEnabledAt[gte]string
twoFactorBackupCodesEnabledAt[lt]string
twoFactorBackupCodesEnabledAt[lte]string
curl -i -X GET \
  'https://api.askara.ai/users?page=1&itemsPerPage=20&order%5Bid%5D=asc&order%5Buuid%5D=asc&order%5BstripeCustomerId%5D=asc&order%5Bemail%5D=asc&order%5BtrustedVersion%5D=asc&order%5BcreatedAt%5D=asc&order%5BupdatedAt%5D=asc&order%5BlastLoginAt%5D=asc&order%5BlastSessionAt%5D=asc&order%5BbanishedAt%5D=asc&order%5BtwoFactorSmsEnabledAt%5D=asc&order%5BtwoFactorEmailEnabledAt%5D=asc&order%5BtwoFactorTotpEnabledAt%5D=asc&order%5BtwoFactorGoogleEnabledAt%5D=asc&order%5BtwoFactorBackupCodesEnabledAt%5D=asc&order%5BfirstName%5D=asc&order%5BlastName%5D=asc&order%5Bgender%5D=asc&order%5BisVerified%5D=asc&order%5Bphone%5D=asc&order%5Brpps%5D=asc&order%5Bam%5D=asc&order%5Blanguage%5D=asc&order%5Btimezone%5D=asc&order%5BlanguageSpoken%5D=asc&order%5BlanguageDocument%5D=asc&order%5BdisplayGodMode%5D=asc&search=string&id=0&id%5B%5D=0&uuid=string&uuid%5B%5D=string&stripeCustomerId=string&stripeCustomerId%5B%5D=string&email=string&email%5B%5D=string&totpSecret=string&totpSecret%5B%5D=string&googleAuthenticatorSecret=string&googleAuthenticatorSecret%5B%5D=string&authCode=string&authCode%5B%5D=string&trustedVersion=0&trustedVersion%5B%5D=0&firstName=string&lastName=string&gender=string&gender%5B%5D=string&isVerified=true&isVerified%5B%5D=true&phone=string&phone%5B%5D=string&rpps=string&rpps%5B%5D=string&am=string&am%5B%5D=string&studentStatus=string&studentStatus%5B%5D=string&language=string&language%5B%5D=string&timezone=string&timezone%5B%5D=string&languageSpoken=string&languageSpoken%5B%5D=string&languageDocument=string&languageDocument%5B%5D=string&personalization=string&personalization%5B%5D=string&displayGodMode=true&displayGodMode%5B%5D=true&createdAt%5Bbetween%5D=string&createdAt%5Bgt%5D=string&createdAt%5Bgte%5D=string&createdAt%5Blt%5D=string&createdAt%5Blte%5D=string&updatedAt%5Bbetween%5D=string&updatedAt%5Bgt%5D=string&updatedAt%5Bgte%5D=string&updatedAt%5Blt%5D=string&updatedAt%5Blte%5D=string&lastLoginAt%5Bbetween%5D=string&lastLoginAt%5Bgt%5D=string&lastLoginAt%5Bgte%5D=string&lastLoginAt%5Blt%5D=string&lastLoginAt%5Blte%5D=string&lastSessionAt%5Bbetween%5D=string&lastSessionAt%5Bgt%5D=string&lastSessionAt%5Bgte%5D=string&lastSessionAt%5Blt%5D=string&lastSessionAt%5Blte%5D=string&banishedAt%5Bbetween%5D=string&banishedAt%5Bgt%5D=string&banishedAt%5Bgte%5D=string&banishedAt%5Blt%5D=string&banishedAt%5Blte%5D=string&twoFactorSmsEnabledAt%5Bbetween%5D=string&twoFactorSmsEnabledAt%5Bgt%5D=string&twoFactorSmsEnabledAt%5Bgte%5D=string&twoFactorSmsEnabledAt%5Blt%5D=string&twoFactorSmsEnabledAt%5Blte%5D=string&twoFactorEmailEnabledAt%5Bbetween%5D=string&twoFactorEmailEnabledAt%5Bgt%5D=string&twoFactorEmailEnabledAt%5Bgte%5D=string&twoFactorEmailEnabledAt%5Blt%5D=string&twoFactorEmailEnabledAt%5Blte%5D=string&twoFactorTotpEnabledAt%5Bbetween%5D=string&twoFactorTotpEnabledAt%5Bgt%5D=string&twoFactorTotpEnabledAt%5Bgte%5D=string&twoFactorTotpEnabledAt%5Blt%5D=string&twoFactorTotpEnabledAt%5Blte%5D=string&twoFactorGoogleEnabledAt%5Bbetween%5D=string&twoFactorGoogleEnabledAt%5Bgt%5D=string&twoFactorGoogleEnabledAt%5Bgte%5D=string&twoFactorGoogleEnabledAt%5Blt%5D=string&twoFactorGoogleEnabledAt%5Blte%5D=string&twoFactorBackupCodesEnabledAt%5Bbetween%5D=string&twoFactorBackupCodesEnabledAt%5Bgt%5D=string&twoFactorBackupCodesEnabledAt%5Bgte%5D=string&twoFactorBackupCodesEnabledAt%5Blt%5D=string&twoFactorBackupCodesEnabledAt%5Blte%5D=string'

Responses

User collection

Body
Array [
uuidstring(uuid)

User unique identifier.

emailstring(email)required

User email address.

https://schema.org/email
createdAtstring(date-time)

User creation date.

updatedAtstring(date-time)

User update date.

firstNamestringrequired

User first name.

lastNamestringrequired

User last name.

genderstring or nullrequired

User gender.

Default "unknown"
Enum"female""male""unknown"null
Example: "unknown"
phonestring or nullrequired

User phone number.

Example: "+33757590893"
rppsstring or null= 11 characters^(\d+)$

User RPPS number (France).

Example: "10101748050"
amstring or null= 9 characters^(\d+)$

User AM number (France).

Example: "394003552"
]
Response
[
  {
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "email": "user@example.com",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "firstName": "string",
    "lastName": "string",
    "gender": "unknown",
    "phone": "+33757590893",
    "rpps": "10101748050",
    "am": "394003552"
  }
]

Retrieve one user.

Request

Use this endpoint to retrieve a user information.

Path
uuidstringrequired

User identifier

curl -i -X GET \
  'https://api.askara.ai/users/{uuid}'

Responses

User resource

Body
uuidstring(uuid)

User unique identifier.

emailstring(email)required

User email address.

https://schema.org/email
createdAtstring(date-time)

User creation date.

updatedAtstring(date-time)

User update date.

firstNamestringrequired

User first name.

lastNamestringrequired

User last name.

genderstring or nullrequired

User gender.

Default "unknown"
Enum"female""male""unknown"null
Example: "unknown"
isVerifiedboolean

User email address verification status.

Default false
Example: false
phonestring or nullrequired

User phone number.

Example: "+33757590893"
rppsstring or null= 11 characters^(\d+)$

User RPPS number (France).

Example: "10101748050"
amstring or null= 9 characters^(\d+)$

User AM number (France).

Example: "394003552"
organizationsArray of objects(Organization-user.read_user.read_organization)

User organizations.

Response
{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "email": "user@example.com",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "firstName": "string",
  "lastName": "string",
  "gender": "unknown",
  "isVerified": false,
  "phone": "+33757590893",
  "rpps": "10101748050",
  "am": "394003552",
  "organizations": [
    { … }
  ]
}

Webhook

Operations