# Askara API

Askara.ai open API

Version: 1.4.0

## Servers

Production
```
https://api.askara.ai
```

## Security

### oauthAuthCode

OAuth 2.0 Authorization Code Grant

Type: oauth2

### bearerAuth

API Key provided in the Authorization header

Type: apiKey
In: header
Name: Authorization

## Download OpenAPI description

[Askara API](https://developers.askara.ai/_bundle/apis/askara-symfony/askara-api.yaml)

## Audio

Resource 'Audio' operations.

### Retrieve collection of audios.

 - [GET /audios](https://developers.askara.ai/apis/askara-symfony/askara-api/audio/api_audios.md): Use this endpoint to retrieve the collection of audio information.

### Retrieve an audio.

 - [GET /audios/{uuid}](https://developers.askara.ai/apis/askara-symfony/askara-api/audio/api_audio.md): Use this endpoint to retrieve an audio information.

## Contact

Resource 'Contact' operations.

### Retrieve collection of contacts.

 - [GET /contacts](https://developers.askara.ai/apis/askara-symfony/askara-api/contact/api_contacts.md): Use this endpoint to retrieve the collection of contact information.

### Create a contact.

 - [POST /contacts](https://developers.askara.ai/apis/askara-symfony/askara-api/contact/api_contact_create.md): Use this endpoint to create a contact entity.

### Retrieve a contact.

 - [GET /contacts/{uuid}](https://developers.askara.ai/apis/askara-symfony/askara-api/contact/api_contact.md): Use this endpoint to retrieve a contact information.

### Patch a contact.

 - [PATCH /contacts/{uuid}](https://developers.askara.ai/apis/askara-symfony/askara-api/contact/api_contact_patch.md): Use this endpoint to update a contact entity.

## Document

Resource 'Document' operations.

### Retrieve collection of document entities.

 - [GET /documents](https://developers.askara.ai/apis/askara-symfony/askara-api/document/api_documents.md): Use this endpoint to retrieve the collection of document information.

### Retrieve a document entity.

 - [GET /documents/{uuid}](https://developers.askara.ai/apis/askara-symfony/askara-api/document/api_document.md): Use this endpoint to retrieve a document information.

### Set a document synchronization status.

 - [POST /documents/{uuid}/status](https://developers.askara.ai/apis/askara-symfony/askara-api/document/api_document_status.md): Use this endpoint to set a document synchronization status.

## Note

Resource 'Note' operations.

### Retrieve collection of notes.

 - [GET /notes](https://developers.askara.ai/apis/askara-symfony/askara-api/note/api_notes.md): Use this endpoint to retrieve a collection of notes.

### Retrieve a note.

 - [GET /notes/{uuid}](https://developers.askara.ai/apis/askara-symfony/askara-api/note/api_note.md): Use this endpoint to retrieve a note information.

## Organization

Resource 'Organization' operations.

### Retrieve collection of organization entities.

 - [GET /organizations](https://developers.askara.ai/apis/askara-symfony/askara-api/organization/api_organizations.md): Use this endpoint to retrieve the collection of organization information.

### Retrieve an organization entity.

 - [GET /organizations/{uuid}](https://developers.askara.ai/apis/askara-symfony/askara-api/organization/api_organization.md): Use this endpoint to retrieve an organization information.

## Patient

Resource 'Patient' operations.

### Retrieve collection of patients.

 - [GET /patients](https://developers.askara.ai/apis/askara-symfony/askara-api/patient/api_patients.md): Use this endpoint to retrieve the collection of patient information.

### Create or update a patient.

 - [POST /patients](https://developers.askara.ai/apis/askara-symfony/askara-api/patient/api_patient_create.md): Use this endpoint to create a patient entity or update an existing one if it already exists. A patient is considered existing if it matches by externalId OR by the combination of firstName + lastName + dateOfBirth.

### Retrieve a patient.

 - [GET /patients/{uuid}](https://developers.askara.ai/apis/askara-symfony/askara-api/patient/api_patient.md): Use this endpoint to retrieve a patient information.

### Patch a patient.

 - [PATCH /patients/{uuid}](https://developers.askara.ai/apis/askara-symfony/askara-api/patient/api_patient_patch.md): Use this endpoint to update a patient entity.

## User

Resource 'User' operations.

### Retrieve current user.

 - [GET /me](https://developers.askara.ai/apis/askara-symfony/askara-api/user/api_me.md): Use this endpoint to retrieve the current user information.

### Retrieve one user.

 - [GET /users/{uuid}](https://developers.askara.ai/apis/askara-symfony/askara-api/user/api_user.md): Use this endpoint to retrieve a user information.

## Webhook

Resource 'Webhook' operations.

### Retrieve collection of webhooks.

 - [GET /webhooks](https://developers.askara.ai/apis/askara-symfony/askara-api/webhook/api_webhooks.md): Use this endpoint to retrieve the collection of webhook information.

### Create a webhook.

 - [POST /webhooks](https://developers.askara.ai/apis/askara-symfony/askara-api/webhook/api_webhook_create.md): Use this endpoint to create a webhook entity.

### Retrieve a webhook.

 - [GET /webhooks/{uuid}](https://developers.askara.ai/apis/askara-symfony/askara-api/webhook/api_webhook.md): Use this endpoint to retrieve a webhook information.

### Delete a webhook.

 - [DELETE /webhooks/{uuid}](https://developers.askara.ai/apis/askara-symfony/askara-api/webhook/api_webhook_delete.md): Use this endpoint to delete a webhook entity.

### Patch a webhook.

 - [PATCH /webhooks/{uuid}](https://developers.askara.ai/apis/askara-symfony/askara-api/webhook/api_webhook_patch.md): Use this endpoint to update a webhook entity.