Create location
curl --request POST \
--url https://api.clinikapi.com/v1/locations \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"description": "<string>",
"type": [
"<string>"
],
"alias": [
"<string>"
],
"phone": "<string>",
"email": "[email protected]",
"address": {
"line": [
"<string>"
],
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>"
},
"physicalType": "<string>",
"position": {
"longitude": 123,
"latitude": 123,
"altitude": 123
},
"managingOrganizationId": "<string>",
"partOfId": "<string>",
"hoursOfOperation": [
{
"daysOfWeek": [],
"allDay": true,
"openingTime": "<string>",
"closingTime": "<string>"
}
],
"availabilityExceptions": "<string>"
}
'import requests
url = "https://api.clinikapi.com/v1/locations"
payload = {
"name": "<string>",
"description": "<string>",
"type": ["<string>"],
"alias": ["<string>"],
"phone": "<string>",
"email": "[email protected]",
"address": {
"line": ["<string>"],
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>"
},
"physicalType": "<string>",
"position": {
"longitude": 123,
"latitude": 123,
"altitude": 123
},
"managingOrganizationId": "<string>",
"partOfId": "<string>",
"hoursOfOperation": [
{
"daysOfWeek": [],
"allDay": True,
"openingTime": "<string>",
"closingTime": "<string>"
}
],
"availabilityExceptions": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
type: ['<string>'],
alias: ['<string>'],
phone: '<string>',
email: '[email protected]',
address: {
line: ['<string>'],
city: '<string>',
state: '<string>',
postalCode: '<string>',
country: '<string>'
},
physicalType: '<string>',
position: {longitude: 123, latitude: 123, altitude: 123},
managingOrganizationId: '<string>',
partOfId: '<string>',
hoursOfOperation: [
{daysOfWeek: [], allDay: true, openingTime: '<string>', closingTime: '<string>'}
],
availabilityExceptions: '<string>'
})
};
fetch('https://api.clinikapi.com/v1/locations', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.clinikapi.com/v1/locations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'type' => [
'<string>'
],
'alias' => [
'<string>'
],
'phone' => '<string>',
'email' => '[email protected]',
'address' => [
'line' => [
'<string>'
],
'city' => '<string>',
'state' => '<string>',
'postalCode' => '<string>',
'country' => '<string>'
],
'physicalType' => '<string>',
'position' => [
'longitude' => 123,
'latitude' => 123,
'altitude' => 123
],
'managingOrganizationId' => '<string>',
'partOfId' => '<string>',
'hoursOfOperation' => [
[
'daysOfWeek' => [
],
'allDay' => true,
'openingTime' => '<string>',
'closingTime' => '<string>'
]
],
'availabilityExceptions' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.clinikapi.com/v1/locations"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"type\": [\n \"<string>\"\n ],\n \"alias\": [\n \"<string>\"\n ],\n \"phone\": \"<string>\",\n \"email\": \"[email protected]\",\n \"address\": {\n \"line\": [\n \"<string>\"\n ],\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"physicalType\": \"<string>\",\n \"position\": {\n \"longitude\": 123,\n \"latitude\": 123,\n \"altitude\": 123\n },\n \"managingOrganizationId\": \"<string>\",\n \"partOfId\": \"<string>\",\n \"hoursOfOperation\": [\n {\n \"daysOfWeek\": [],\n \"allDay\": true,\n \"openingTime\": \"<string>\",\n \"closingTime\": \"<string>\"\n }\n ],\n \"availabilityExceptions\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.clinikapi.com/v1/locations")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"type\": [\n \"<string>\"\n ],\n \"alias\": [\n \"<string>\"\n ],\n \"phone\": \"<string>\",\n \"email\": \"[email protected]\",\n \"address\": {\n \"line\": [\n \"<string>\"\n ],\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"physicalType\": \"<string>\",\n \"position\": {\n \"longitude\": 123,\n \"latitude\": 123,\n \"altitude\": 123\n },\n \"managingOrganizationId\": \"<string>\",\n \"partOfId\": \"<string>\",\n \"hoursOfOperation\": [\n {\n \"daysOfWeek\": [],\n \"allDay\": true,\n \"openingTime\": \"<string>\",\n \"closingTime\": \"<string>\"\n }\n ],\n \"availabilityExceptions\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clinikapi.com/v1/locations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"type\": [\n \"<string>\"\n ],\n \"alias\": [\n \"<string>\"\n ],\n \"phone\": \"<string>\",\n \"email\": \"[email protected]\",\n \"address\": {\n \"line\": [\n \"<string>\"\n ],\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"physicalType\": \"<string>\",\n \"position\": {\n \"longitude\": 123,\n \"latitude\": 123,\n \"altitude\": 123\n },\n \"managingOrganizationId\": \"<string>\",\n \"partOfId\": \"<string>\",\n \"hoursOfOperation\": [\n {\n \"daysOfWeek\": [],\n \"allDay\": true,\n \"openingTime\": \"<string>\",\n \"closingTime\": \"<string>\"\n }\n ],\n \"availabilityExceptions\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"error": "<string>",
"message": "<string>",
"code": "<string>",
"requestId": "<string>",
"issues": [
{
"severity": "<string>",
"code": "<string>",
"diagnostics": "<string>"
}
]
}Locations
Create Location
POST
/
v1
/
locations
Create location
curl --request POST \
--url https://api.clinikapi.com/v1/locations \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"description": "<string>",
"type": [
"<string>"
],
"alias": [
"<string>"
],
"phone": "<string>",
"email": "[email protected]",
"address": {
"line": [
"<string>"
],
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>"
},
"physicalType": "<string>",
"position": {
"longitude": 123,
"latitude": 123,
"altitude": 123
},
"managingOrganizationId": "<string>",
"partOfId": "<string>",
"hoursOfOperation": [
{
"daysOfWeek": [],
"allDay": true,
"openingTime": "<string>",
"closingTime": "<string>"
}
],
"availabilityExceptions": "<string>"
}
'import requests
url = "https://api.clinikapi.com/v1/locations"
payload = {
"name": "<string>",
"description": "<string>",
"type": ["<string>"],
"alias": ["<string>"],
"phone": "<string>",
"email": "[email protected]",
"address": {
"line": ["<string>"],
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>"
},
"physicalType": "<string>",
"position": {
"longitude": 123,
"latitude": 123,
"altitude": 123
},
"managingOrganizationId": "<string>",
"partOfId": "<string>",
"hoursOfOperation": [
{
"daysOfWeek": [],
"allDay": True,
"openingTime": "<string>",
"closingTime": "<string>"
}
],
"availabilityExceptions": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
type: ['<string>'],
alias: ['<string>'],
phone: '<string>',
email: '[email protected]',
address: {
line: ['<string>'],
city: '<string>',
state: '<string>',
postalCode: '<string>',
country: '<string>'
},
physicalType: '<string>',
position: {longitude: 123, latitude: 123, altitude: 123},
managingOrganizationId: '<string>',
partOfId: '<string>',
hoursOfOperation: [
{daysOfWeek: [], allDay: true, openingTime: '<string>', closingTime: '<string>'}
],
availabilityExceptions: '<string>'
})
};
fetch('https://api.clinikapi.com/v1/locations', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.clinikapi.com/v1/locations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'type' => [
'<string>'
],
'alias' => [
'<string>'
],
'phone' => '<string>',
'email' => '[email protected]',
'address' => [
'line' => [
'<string>'
],
'city' => '<string>',
'state' => '<string>',
'postalCode' => '<string>',
'country' => '<string>'
],
'physicalType' => '<string>',
'position' => [
'longitude' => 123,
'latitude' => 123,
'altitude' => 123
],
'managingOrganizationId' => '<string>',
'partOfId' => '<string>',
'hoursOfOperation' => [
[
'daysOfWeek' => [
],
'allDay' => true,
'openingTime' => '<string>',
'closingTime' => '<string>'
]
],
'availabilityExceptions' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.clinikapi.com/v1/locations"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"type\": [\n \"<string>\"\n ],\n \"alias\": [\n \"<string>\"\n ],\n \"phone\": \"<string>\",\n \"email\": \"[email protected]\",\n \"address\": {\n \"line\": [\n \"<string>\"\n ],\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"physicalType\": \"<string>\",\n \"position\": {\n \"longitude\": 123,\n \"latitude\": 123,\n \"altitude\": 123\n },\n \"managingOrganizationId\": \"<string>\",\n \"partOfId\": \"<string>\",\n \"hoursOfOperation\": [\n {\n \"daysOfWeek\": [],\n \"allDay\": true,\n \"openingTime\": \"<string>\",\n \"closingTime\": \"<string>\"\n }\n ],\n \"availabilityExceptions\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.clinikapi.com/v1/locations")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"type\": [\n \"<string>\"\n ],\n \"alias\": [\n \"<string>\"\n ],\n \"phone\": \"<string>\",\n \"email\": \"[email protected]\",\n \"address\": {\n \"line\": [\n \"<string>\"\n ],\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"physicalType\": \"<string>\",\n \"position\": {\n \"longitude\": 123,\n \"latitude\": 123,\n \"altitude\": 123\n },\n \"managingOrganizationId\": \"<string>\",\n \"partOfId\": \"<string>\",\n \"hoursOfOperation\": [\n {\n \"daysOfWeek\": [],\n \"allDay\": true,\n \"openingTime\": \"<string>\",\n \"closingTime\": \"<string>\"\n }\n ],\n \"availabilityExceptions\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clinikapi.com/v1/locations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"type\": [\n \"<string>\"\n ],\n \"alias\": [\n \"<string>\"\n ],\n \"phone\": \"<string>\",\n \"email\": \"[email protected]\",\n \"address\": {\n \"line\": [\n \"<string>\"\n ],\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"physicalType\": \"<string>\",\n \"position\": {\n \"longitude\": 123,\n \"latitude\": 123,\n \"altitude\": 123\n },\n \"managingOrganizationId\": \"<string>\",\n \"partOfId\": \"<string>\",\n \"hoursOfOperation\": [\n {\n \"daysOfWeek\": [],\n \"allDay\": true,\n \"openingTime\": \"<string>\",\n \"closingTime\": \"<string>\"\n }\n ],\n \"availabilityExceptions\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"error": "<string>",
"message": "<string>",
"code": "<string>",
"requestId": "<string>",
"issues": [
{
"severity": "<string>",
"code": "<string>",
"diagnostics": "<string>"
}
]
}Authorizations
Your ClinikAPI secret key (clk_live_* or clk_test_*)
Body
application/json
Maximum string length:
500Available options:
active, suspended, inactive Maximum string length:
2000Available options:
instance, kind Maximum array length:
10Maximum string length:
200Maximum array length:
10Maximum string length:
200Maximum string length:
20Maximum string length:
200Show child attributes
Show child attributes
Physical form (building, wing, room, bed, vehicle)
Maximum string length:
200GPS coordinates
Show child attributes
Show child attributes
Organization that manages this location
Parent location ID
Maximum array length:
20Show child attributes
Show child attributes
Maximum string length:
2000Response
Location created
⌘I