Retrieve collection of contacts.

Contact

Operations

Retrieve collection of contacts.

Request

Use this endpoint to retrieve the collection of contact 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[firstName]string

Default "asc"

Enum"asc""desc"

order[lastName]string

Default "asc"

Enum"asc""desc"

order[legalName]string

Default "asc"

Enum"asc""desc"

order[languageSpoken]string

Default "asc"

Enum"asc""desc"

order[TVDistinction]string

Default "asc"

Enum"asc""desc"

order[createdAt]string

Default "asc"

Enum"asc""desc"

order[updatedAt]string

Default "asc"

Enum"asc""desc"

order[gender]string

Default "asc"

Enum"asc""desc"

order[visibilityOption]string

Default "asc"

Enum"asc""desc"

order[type]string

Default "asc"

Enum"asc""desc"

order[email]string

Default "asc"

Enum"asc""desc"

order[phone]string

Default "asc"

Enum"asc""desc"

searchstring

Global case-insensitive text search.

idinteger

id[]Array of integers

uuidstring

uuid[]Array of strings

firstNamestring

lastNamestring

legalNamestring

genderstring

gender[]Array of strings

TVDistinctionstring

TVDistinction[]Array of strings

languageSpokenstring

languageSpoken[]Array of strings

emailstring

email[]Array of strings

user.emailstring

user.email[]Array of strings

user.uuidstring

user.uuid[]Array of strings

visibilityOptionstring

visibilityOption[]Array of strings

phonestring

phone[]Array of strings

typestring

type[]Array of strings

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

curl -i -X GET \
  'https://api.askara.ai/contacts?page=1&itemsPerPage=20&order%5Bid%5D=asc&order%5Buuid%5D=asc&order%5BfirstName%5D=asc&order%5BlastName%5D=asc&order%5BlegalName%5D=asc&order%5BlanguageSpoken%5D=asc&order%5BTVDistinction%5D=asc&order%5BcreatedAt%5D=asc&order%5BupdatedAt%5D=asc&order%5Bgender%5D=asc&order%5BvisibilityOption%5D=asc&order%5Btype%5D=asc&order%5Bemail%5D=asc&order%5Bphone%5D=asc&search=string&id=0&id%5B%5D=0&uuid=string&uuid%5B%5D=string&firstName=string&lastName=string&legalName=string&gender=string&gender%5B%5D=string&TVDistinction=string&TVDistinction%5B%5D=string&languageSpoken=string&languageSpoken%5B%5D=string&email=string&email%5B%5D=string&user.email=string&user.email%5B%5D=string&user.uuid=string&user.uuid%5B%5D=string&visibilityOption=string&visibilityOption%5B%5D=string&phone=string&phone%5B%5D=string&type=string&type%5B%5D=string&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'

Responses

Contact collection

Body

Array [

uuidstring(uuid)

Contact unique identifier.

firstNamestring or null

Contact first name.

lastNamestring or null

Contact last name.

legalNamestring or null

Contact legal name.

genderstring or null

Contact gender.

Default "unknown"

Enum"female""male""unknown"null

Example: "unknown"

TVDistinctionstring or null

Contact T-V distinction.

Default "v"

Enum"t""v"null

Example: "v"

languageSpokenstring

Contact spoken language.

createdAtstring(date-time)

Contact creation date.

updatedAtstring(date-time)

Contact update date.

emailstring or null(email)

Contact email address.

https://schema.org/email

phonestring or null

Contact phone number.

Example: "+33757590893"

typestring or null

Contact type.

Enum"correspondent""laboratory""dental_technician""other"null

]

Response

[
  {
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "firstName": "string",
    "lastName": "string",
    "legalName": "string",
    "gender": "unknown",
    "TVDistinction": "v",
    "languageSpoken": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "email": "user@example.com",
    "phone": "+33757590893",
    "type": "correspondent"
  }
]

Create a contact.

Request

Use this endpoint to create a contact entity.

Body

required

The new Contact resource

firstNamestring or null

Contact first name.

lastNamestring or null

Contact last name.

legalNamestring or null

Contact legal name.

genderstring or null

Contact gender.

Default "unknown"

Enum"female""male""unknown"null

Example: "unknown"

TVDistinctionstring or null

Contact T-V distinction.

Default "v"

Enum"t""v"null

Example: "v"

languageSpokenstring

Contact spoken language.

emailstring or null(email)

Contact email address.

https://schema.org/email

visibilityOptionstring or null

Default "shared"

Enum"shared""private"null

Example: "shared"

phonestring or null

Contact phone number.

Example: "+33757590893"

typestring or null

Contact type.

Enum"correspondent""laboratory""dental_technician""other"null

curl -i -X POST \
  https://api.askara.ai/contacts \
  -H 'Content-Type: application/json' \
  -d '{
    "firstName": "string",
    "lastName": "string",
    "legalName": "string",
    "gender": "unknown",
    "TVDistinction": "v",
    "languageSpoken": "string",
    "email": "user@example.com",
    "visibilityOption": "shared",
    "phone": "+33757590893",
    "type": "correspondent"
  }'

Responses

Contact resource created

Body

uuidstring(uuid)

Contact unique identifier.

firstNamestring or null

Contact first name.

lastNamestring or null

Contact last name.

legalNamestring or null

Contact legal name.

genderstring or null

Contact gender.

Default "unknown"

Enum"female""male""unknown"null

Example: "unknown"

TVDistinctionstring or null

Contact T-V distinction.

Default "v"

Enum"t""v"null

Example: "v"

languageSpokenstring

Contact spoken language.

createdAtstring(date-time)

Contact creation date.

updatedAtstring(date-time)

Contact update date.

emailstring or null(email)

Contact email address.

https://schema.org/email

phonestring or null

Contact phone number.

Example: "+33757590893"

typestring or null

Contact type.

Enum"correspondent""laboratory""dental_technician""other"null

Response

{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "firstName": "string",
  "lastName": "string",
  "legalName": "string",
  "gender": "unknown",
  "TVDistinction": "v",
  "languageSpoken": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "email": "user@example.com",
  "phone": "+33757590893",
  "type": "correspondent"
}

Retrieve a contact.

Request

Use this endpoint to retrieve a contact information.

Path

uuidstringrequired

Contact identifier

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

Responses

Contact resource

Body

uuidstring(uuid)

Contact unique identifier.

firstNamestring or null

Contact first name.

lastNamestring or null

Contact last name.

legalNamestring or null

Contact legal name.

genderstring or null

Contact gender.

Default "unknown"

Enum"female""male""unknown"null

Example: "unknown"

TVDistinctionstring or null

Contact T-V distinction.

Default "v"

Enum"t""v"null

Example: "v"

languageSpokenstring

Contact spoken language.

createdAtstring(date-time)

Contact creation date.

updatedAtstring(date-time)

Contact update date.

emailstring or null(email)

Contact email address.

https://schema.org/email

phonestring or null

Contact phone number.

Example: "+33757590893"

typestring or null

Contact type.

Enum"correspondent""laboratory""dental_technician""other"null

Response

{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "firstName": "string",
  "lastName": "string",
  "legalName": "string",
  "gender": "unknown",
  "TVDistinction": "v",
  "languageSpoken": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "email": "user@example.com",
  "phone": "+33757590893",
  "type": "correspondent"
}

Document

Operations

Organization

Operations

Patient

Operations

User

Operations

Webhook

Operations

Askara API (1.0.0)

Contact