Skip to content
Askara API/
/
Retrieve an organization...

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

Retrieve collection of organization entities.

Request

Use this endpoint to retrieve the collection of organization information.

Query
pageinteger

The collection page number

Default 1
itemsPerPageinteger[ 0 .. 100 ]

The number of items per page

Default 20
expand[]Array of strings
Items Enum"user.list""user.read""organization.read_webhooks""webhook.read""webhook.list"
order[uuid]string
Enum"asc""desc"
order[streetAddress]string
Enum"asc""desc"
order[postalCode]string
Enum"asc""desc"
order[city]string
Enum"asc""desc"
order[country]string
Enum"asc""desc"
order[latitude]string
Enum"asc""desc"
order[longitude]string
Enum"asc""desc"
order[timezone]string
Enum"asc""desc"
order[phone]string
Enum"asc""desc"
order[secretariatEmail]string
Enum"asc""desc"
order[website]string
Enum"asc""desc"
order[dentalNomenclatureSystem]string
Enum"asc""desc"
order[createdAt]string
Enum"asc""desc"
order[updatedAt]string
Enum"asc""desc"
searchstring

Global case-insensitive text search.

uuidstring
uuid[]Array of strings
namestring
name[]Array of strings
vatNumberstring
vatNumber[]Array of strings
streetAddressstring
streetAddress[]Array of strings
postalCodestring
postalCode[]Array of strings
citystring
city[]Array of strings
countrystring
country[]Array of strings
timezonestring
timezone[]Array of strings
phonestring
phone[]Array of strings
secretariatEmailstring
secretariatEmail[]Array of strings
websitestring
website[]Array of strings
dentalNomenclatureSystemstring
dentalNomenclatureSystem[]Array of strings
subscriptionsstring
subscriptions[]Array of strings
webhooksstring
webhooks[]Array of strings
organizationUsersstring
organizationUsers[]Array of strings
imagesstring
images[]Array of strings
latitude[between]string
latitude[gt]string
latitude[gte]string
latitude[lt]string
latitude[lte]string
longitude[between]string
longitude[gt]string
longitude[gte]string
longitude[lt]string
longitude[lte]string
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/organizations?page=1&itemsPerPage=20&expand%5B%5D=user.list&order%5Buuid%5D=asc&order%5BstreetAddress%5D=asc&order%5BpostalCode%5D=asc&order%5Bcity%5D=asc&order%5Bcountry%5D=asc&order%5Blatitude%5D=asc&order%5Blongitude%5D=asc&order%5Btimezone%5D=asc&order%5Bphone%5D=asc&order%5BsecretariatEmail%5D=asc&order%5Bwebsite%5D=asc&order%5BdentalNomenclatureSystem%5D=asc&order%5BcreatedAt%5D=asc&order%5BupdatedAt%5D=asc&search=string&uuid=string&uuid%5B%5D=string&name=string&name%5B%5D=string&vatNumber=string&vatNumber%5B%5D=string&streetAddress=string&streetAddress%5B%5D=string&postalCode=string&postalCode%5B%5D=string&city=string&city%5B%5D=string&country=string&country%5B%5D=string&timezone=string&timezone%5B%5D=string&phone=string&phone%5B%5D=string&secretariatEmail=string&secretariatEmail%5B%5D=string&website=string&website%5B%5D=string&dentalNomenclatureSystem=string&dentalNomenclatureSystem%5B%5D=string&subscriptions=string&subscriptions%5B%5D=string&webhooks=string&webhooks%5B%5D=string&organizationUsers=string&organizationUsers%5B%5D=string&images=string&images%5B%5D=string&latitude%5Bbetween%5D=string&latitude%5Bgt%5D=string&latitude%5Bgte%5D=string&latitude%5Blt%5D=string&latitude%5Blte%5D=string&longitude%5Bbetween%5D=string&longitude%5Bgt%5D=string&longitude%5Bgte%5D=string&longitude%5Blt%5D=string&longitude%5Blte%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

Organization collection

Body
Array [
uuidstring or null(uuid)

Organization unique identifier.

namestring or null

Organization name.

vatNumberstring or null

Organization VAT number.

streetAddressstring

Organization street address.

postalCodestring

Organization postal code.

citystring

Organization city.

countrystring

Organization country.

phonestring or null

Organization phone number.

Example: "+33757590893"
secretariatEmailstring or null(email)

Organization email address.

https://schema.org/email
websitestring or null(uri)

Organization website url.

https://schema.org/url
dentalNomenclatureSystemstring or null

Organization dental nomenclature system.

Enum"fdi""ada"null
createdAtstring(date-time)

Organization creation date.

updatedAtstring(date-time)

Organization update date.

]
Response
[
  {
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "name": "string",
    "vatNumber": "string",
    "streetAddress": "string",
    "postalCode": "string",
    "city": "string",
    "country": "string",
    "phone": "+33757590893",
    "secretariatEmail": "user@example.com",
    "website": "http://example.com",
    "dentalNomenclatureSystem": "fdi",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
]

Retrieve an organization entity.

Request

Use this endpoint to retrieve an organization information.

Path
uuidstringrequired

Organization identifier

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

Responses

Organization resource

Body
uuidstring or null(uuid)

Organization unique identifier.

namestring or null

Organization name.

vatNumberstring or null

Organization VAT number.

streetAddressstring

Organization street address.

postalCodestring

Organization postal code.

citystring

Organization city.

countrystring

Organization country.

latitudenumber

Organization latitude.

Example: 10.6584
longitudenumber

Organization longitude

Example: 45.0124
timezonestring or null

Organization timezone

Example: "Europe/Paris"
phonestring or null

Organization phone number.

Example: "+33757590893"
secretariatEmailstring or null(email)

Organization email address.

https://schema.org/email
websitestring or null(uri)

Organization website url.

https://schema.org/url
dentalNomenclatureSystemstring or null

Organization dental nomenclature system.

Enum"fdi""ada"null
createdAtstring(date-time)

Organization creation date.

updatedAtstring(date-time)

Organization update date.

usersArray of objects(User-organization.read_organization.read_users_user.read_organization_role_organization.read_logo_organization_user.read_user.list_image.list)read-only
logoImage-organization.read_organization.read_users_user.read_organization_role_organization.read_logo_organization_user.read_user.list_image.list (object) or nullread-only
Any of:
Response
{
  "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": [
    { … }
  ],
  "logo": {
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "title": "string",
    "name": "string",
    "size": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}

Patient

Resource 'Patient' operations.

Operations

User

Resource 'User' operations.

Operations

Webhook

Resource 'Webhook' operations.

Operations