Skip to content
/User

Askara API (1.0.0)

Askara.ai open API

Languages
Servers
Production

https://api.askara.ai/

Contact

Resource 'Contact' operations.

Operations

Document

Resource 'Document' operations.

Operations

Organization

Resource 'Organization' operations.

Operations

Patient

Resource 'Patient' operations.

Operations

User

Resource 'User' operations.

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 or null(uuid)
emailstring or null
firstNamestring or null
lastNamestring or null
genderstring or null
Enum"female""male""unknown"null
isVerifiedboolean or null
phonestring or null
rppsstring or null
amstring or null
languagestring or null
timezonestring or null
languageSpokenAutoDetectboolean or null
languageSpokenstring or null
languageDocumentstring or null
organizationOrganization-user.read_user.read_organization_organization.read_organization.read_users_user.list_user.read_organization_role (object) or null
Any of:
organizationRolestring or null
Enum"ROLE_ORGANIZATION_ADMIN""ROLE_ORGANIZATION_MEMBER"null
Response
{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "email": "string",
  "firstName": "string",
  "lastName": "string",
  "gender": "female",
  "isVerified": true,
  "phone": "string",
  "rpps": "string",
  "am": "string",
  "language": "string",
  "timezone": "string",
  "languageSpokenAutoDetect": true,
  "languageSpoken": "string",
  "languageDocument": "string",
  "organization": {
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "name": "string",
    "vatNumber": "string",
    "streetAddress": "string",
    "postalCode": "string",
    "city": "string",
    "country": "string",
    "latitude": 10.6584,
    "longitude": 45.0124,
    "timezone": "Europe/Paris",
    "phone": "+33757590893",
    "secretariatEmail": "user@example.com",
    "website": "http://example.com",
    "dentalNomenclatureSystem": "fdi",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "users": [ … ]
  },
  "organizationRole": "ROLE_ORGANIZATION_ADMIN"
}

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.

firstNamestring or nullrequired

User first name.

lastNamestring or nullrequired

User last name.

genderstring or nullrequired

User gender.

Default "unknown"
Enum"female""male""unknown"null
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"
languagestring

User interface language.

Default "fr"
organizationsArray of objects(Organization-user.read_user.read_organizations_organization.read)read-only
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": "female",
  "phone": "+33757590893",
  "rpps": "10101748050",
  "am": "394003552",
  "language": "fr",
  "organizations": [
    { … }
  ]
}

Webhook

Resource 'Webhook' operations.

Operations