Add Organisation
curl --request POST \
--url https://api.{tenant}.getomneo.com/api/v3/organisations \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"handle": "<string>",
"description": "<string>",
"short_description": "<string>",
"icon": "<string>",
"image_url": "<string>",
"notes": "<string>",
"status": "<string>",
"is_tenant": true,
"is_active": true,
"phone": "<string>",
"email": "jsmith@example.com",
"secondary_phone": "<string>",
"domain": "<string>",
"authorised_domains": "<string>",
"meta": [
"<string>"
],
"address": {
"address_line_1": "<string>",
"address_line_2": "<string>",
"address_line_3": "<string>",
"company": "<string>",
"is_default": true,
"latitude": 123,
"longitude": 123,
"city": "<string>",
"postcode": "<string>",
"state": "<string>",
"country": "<string>",
"notes": "<string>",
"iso": "<string>",
"iso_state": "<string>"
},
"locations": [
123
],
"custom_fields": [
{
"namespace": "<string>",
"handle": "<string>",
"value": "<string>"
}
]
}
'import requests
url = "https://api.{tenant}.getomneo.com/api/v3/organisations"
payload = {
"name": "<string>",
"handle": "<string>",
"description": "<string>",
"short_description": "<string>",
"icon": "<string>",
"image_url": "<string>",
"notes": "<string>",
"status": "<string>",
"is_tenant": True,
"is_active": True,
"phone": "<string>",
"email": "jsmith@example.com",
"secondary_phone": "<string>",
"domain": "<string>",
"authorised_domains": "<string>",
"meta": ["<string>"],
"address": {
"address_line_1": "<string>",
"address_line_2": "<string>",
"address_line_3": "<string>",
"company": "<string>",
"is_default": True,
"latitude": 123,
"longitude": 123,
"city": "<string>",
"postcode": "<string>",
"state": "<string>",
"country": "<string>",
"notes": "<string>",
"iso": "<string>",
"iso_state": "<string>"
},
"locations": [123],
"custom_fields": [
{
"namespace": "<string>",
"handle": "<string>",
"value": "<string>"
}
]
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
handle: '<string>',
description: '<string>',
short_description: '<string>',
icon: '<string>',
image_url: '<string>',
notes: '<string>',
status: '<string>',
is_tenant: true,
is_active: true,
phone: '<string>',
email: 'jsmith@example.com',
secondary_phone: '<string>',
domain: '<string>',
authorised_domains: '<string>',
meta: ['<string>'],
address: {
address_line_1: '<string>',
address_line_2: '<string>',
address_line_3: '<string>',
company: '<string>',
is_default: true,
latitude: 123,
longitude: 123,
city: '<string>',
postcode: '<string>',
state: '<string>',
country: '<string>',
notes: '<string>',
iso: '<string>',
iso_state: '<string>'
},
locations: [123],
custom_fields: [{namespace: '<string>', handle: '<string>', value: '<string>'}]
})
};
fetch('https://api.{tenant}.getomneo.com/api/v3/organisations', 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.{tenant}.getomneo.com/api/v3/organisations",
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>',
'handle' => '<string>',
'description' => '<string>',
'short_description' => '<string>',
'icon' => '<string>',
'image_url' => '<string>',
'notes' => '<string>',
'status' => '<string>',
'is_tenant' => true,
'is_active' => true,
'phone' => '<string>',
'email' => 'jsmith@example.com',
'secondary_phone' => '<string>',
'domain' => '<string>',
'authorised_domains' => '<string>',
'meta' => [
'<string>'
],
'address' => [
'address_line_1' => '<string>',
'address_line_2' => '<string>',
'address_line_3' => '<string>',
'company' => '<string>',
'is_default' => true,
'latitude' => 123,
'longitude' => 123,
'city' => '<string>',
'postcode' => '<string>',
'state' => '<string>',
'country' => '<string>',
'notes' => '<string>',
'iso' => '<string>',
'iso_state' => '<string>'
],
'locations' => [
123
],
'custom_fields' => [
[
'namespace' => '<string>',
'handle' => '<string>',
'value' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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.{tenant}.getomneo.com/api/v3/organisations"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"handle\": \"<string>\",\n \"description\": \"<string>\",\n \"short_description\": \"<string>\",\n \"icon\": \"<string>\",\n \"image_url\": \"<string>\",\n \"notes\": \"<string>\",\n \"status\": \"<string>\",\n \"is_tenant\": true,\n \"is_active\": true,\n \"phone\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"secondary_phone\": \"<string>\",\n \"domain\": \"<string>\",\n \"authorised_domains\": \"<string>\",\n \"meta\": [\n \"<string>\"\n ],\n \"address\": {\n \"address_line_1\": \"<string>\",\n \"address_line_2\": \"<string>\",\n \"address_line_3\": \"<string>\",\n \"company\": \"<string>\",\n \"is_default\": true,\n \"latitude\": 123,\n \"longitude\": 123,\n \"city\": \"<string>\",\n \"postcode\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"notes\": \"<string>\",\n \"iso\": \"<string>\",\n \"iso_state\": \"<string>\"\n },\n \"locations\": [\n 123\n ],\n \"custom_fields\": [\n {\n \"namespace\": \"<string>\",\n \"handle\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
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.{tenant}.getomneo.com/api/v3/organisations")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"handle\": \"<string>\",\n \"description\": \"<string>\",\n \"short_description\": \"<string>\",\n \"icon\": \"<string>\",\n \"image_url\": \"<string>\",\n \"notes\": \"<string>\",\n \"status\": \"<string>\",\n \"is_tenant\": true,\n \"is_active\": true,\n \"phone\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"secondary_phone\": \"<string>\",\n \"domain\": \"<string>\",\n \"authorised_domains\": \"<string>\",\n \"meta\": [\n \"<string>\"\n ],\n \"address\": {\n \"address_line_1\": \"<string>\",\n \"address_line_2\": \"<string>\",\n \"address_line_3\": \"<string>\",\n \"company\": \"<string>\",\n \"is_default\": true,\n \"latitude\": 123,\n \"longitude\": 123,\n \"city\": \"<string>\",\n \"postcode\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"notes\": \"<string>\",\n \"iso\": \"<string>\",\n \"iso_state\": \"<string>\"\n },\n \"locations\": [\n 123\n ],\n \"custom_fields\": [\n {\n \"namespace\": \"<string>\",\n \"handle\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.{tenant}.getomneo.com/api/v3/organisations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"handle\": \"<string>\",\n \"description\": \"<string>\",\n \"short_description\": \"<string>\",\n \"icon\": \"<string>\",\n \"image_url\": \"<string>\",\n \"notes\": \"<string>\",\n \"status\": \"<string>\",\n \"is_tenant\": true,\n \"is_active\": true,\n \"phone\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"secondary_phone\": \"<string>\",\n \"domain\": \"<string>\",\n \"authorised_domains\": \"<string>\",\n \"meta\": [\n \"<string>\"\n ],\n \"address\": {\n \"address_line_1\": \"<string>\",\n \"address_line_2\": \"<string>\",\n \"address_line_3\": \"<string>\",\n \"company\": \"<string>\",\n \"is_default\": true,\n \"latitude\": 123,\n \"longitude\": 123,\n \"city\": \"<string>\",\n \"postcode\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"notes\": \"<string>\",\n \"iso\": \"<string>\",\n \"iso_state\": \"<string>\"\n },\n \"locations\": [\n 123\n ],\n \"custom_fields\": [\n {\n \"namespace\": \"<string>\",\n \"handle\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 123,
"name": "<string>",
"handle": "<string>",
"description": "<string>",
"short_description": "<string>",
"icon": "<string>",
"image_url": "<string>",
"notes": "<string>",
"type": "<string>",
"status": "<string>",
"is_tenant": 123,
"is_active": 123,
"phone": "<string>",
"email": "<string>",
"secondary_phone": "<string>",
"domain": "<string>",
"authorised_domains": [
"<unknown>"
],
"meta": [
"<unknown>"
],
"locations": [
{
"id": 123,
"type": "<string>",
"name": "<string>",
"handle": "<string>",
"description": "<string>",
"phone": "<string>",
"email": "<string>",
"timezone": "<string>",
"external_id": "<string>",
"external_code": "<string>",
"is_published": true,
"is_permanently_closed": true,
"address": {
"id": 123,
"address_line_1": "<string>",
"address_line_2": "<string>",
"address_line_3": "<string>",
"company": "<string>",
"latitude": 123,
"longitude": 123,
"city": "<string>",
"postcode": "<string>",
"state": "<string>",
"country": "<string>",
"notes": "<string>",
"external_id": "<string>",
"is_default": true,
"created_at": "<string>",
"updated_at": "<string>",
"meta": [
"<unknown>"
],
"name": "<string>",
"type": "<string>",
"phone": "<string>",
"iso": "<string>",
"iso_state": "<string>",
"profile_id": "<string>",
"custom_fields": {}
},
"normal_hours": [
[
"<unknown>"
]
],
"special_hours": [
[
"<unknown>"
]
],
"tags": [
"<string>"
],
"custom_fields": {},
"icon": "<string>",
"country_iso_3": "<string>",
"image_url": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"departments": [
{
"id": 123,
"name": "<string>",
"handle": "<string>",
"external_id": "<string>",
"external_code": "<string>",
"description": "<string>",
"short_description": "<string>",
"url": "<string>",
"image_url": "<string>",
"internal_note": "<string>",
"meta": [
"<unknown>"
],
"brand_id": 123,
"location_id": 123,
"brand": {
"name": "<string>",
"handle": "<string>"
},
"created_at": "<string>",
"updated_at": "<string>"
}
]
}
],
"address": {
"id": 123,
"address_line_1": "<string>",
"address_line_2": "<string>",
"address_line_3": "<string>",
"company": "<string>",
"latitude": 123,
"longitude": 123,
"city": "<string>",
"postcode": "<string>",
"state": "<string>",
"country": "<string>",
"notes": "<string>",
"external_id": "<string>",
"is_default": true,
"created_at": "<string>",
"updated_at": "<string>",
"meta": [
"<unknown>"
],
"name": "<string>",
"type": "<string>",
"phone": "<string>",
"iso": "<string>",
"iso_state": "<string>",
"profile_id": "<string>",
"custom_fields": {}
},
"custom_fields": {},
"created_at": "<string>",
"updated_at": "<string>"
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>",
"errors": {}
}Organisation
Add Organisation
A POST to the /organisations endpoint allows your application to create organisation.
POST
/
v3
/
organisations
Add Organisation
curl --request POST \
--url https://api.{tenant}.getomneo.com/api/v3/organisations \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"handle": "<string>",
"description": "<string>",
"short_description": "<string>",
"icon": "<string>",
"image_url": "<string>",
"notes": "<string>",
"status": "<string>",
"is_tenant": true,
"is_active": true,
"phone": "<string>",
"email": "jsmith@example.com",
"secondary_phone": "<string>",
"domain": "<string>",
"authorised_domains": "<string>",
"meta": [
"<string>"
],
"address": {
"address_line_1": "<string>",
"address_line_2": "<string>",
"address_line_3": "<string>",
"company": "<string>",
"is_default": true,
"latitude": 123,
"longitude": 123,
"city": "<string>",
"postcode": "<string>",
"state": "<string>",
"country": "<string>",
"notes": "<string>",
"iso": "<string>",
"iso_state": "<string>"
},
"locations": [
123
],
"custom_fields": [
{
"namespace": "<string>",
"handle": "<string>",
"value": "<string>"
}
]
}
'import requests
url = "https://api.{tenant}.getomneo.com/api/v3/organisations"
payload = {
"name": "<string>",
"handle": "<string>",
"description": "<string>",
"short_description": "<string>",
"icon": "<string>",
"image_url": "<string>",
"notes": "<string>",
"status": "<string>",
"is_tenant": True,
"is_active": True,
"phone": "<string>",
"email": "jsmith@example.com",
"secondary_phone": "<string>",
"domain": "<string>",
"authorised_domains": "<string>",
"meta": ["<string>"],
"address": {
"address_line_1": "<string>",
"address_line_2": "<string>",
"address_line_3": "<string>",
"company": "<string>",
"is_default": True,
"latitude": 123,
"longitude": 123,
"city": "<string>",
"postcode": "<string>",
"state": "<string>",
"country": "<string>",
"notes": "<string>",
"iso": "<string>",
"iso_state": "<string>"
},
"locations": [123],
"custom_fields": [
{
"namespace": "<string>",
"handle": "<string>",
"value": "<string>"
}
]
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
handle: '<string>',
description: '<string>',
short_description: '<string>',
icon: '<string>',
image_url: '<string>',
notes: '<string>',
status: '<string>',
is_tenant: true,
is_active: true,
phone: '<string>',
email: 'jsmith@example.com',
secondary_phone: '<string>',
domain: '<string>',
authorised_domains: '<string>',
meta: ['<string>'],
address: {
address_line_1: '<string>',
address_line_2: '<string>',
address_line_3: '<string>',
company: '<string>',
is_default: true,
latitude: 123,
longitude: 123,
city: '<string>',
postcode: '<string>',
state: '<string>',
country: '<string>',
notes: '<string>',
iso: '<string>',
iso_state: '<string>'
},
locations: [123],
custom_fields: [{namespace: '<string>', handle: '<string>', value: '<string>'}]
})
};
fetch('https://api.{tenant}.getomneo.com/api/v3/organisations', 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.{tenant}.getomneo.com/api/v3/organisations",
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>',
'handle' => '<string>',
'description' => '<string>',
'short_description' => '<string>',
'icon' => '<string>',
'image_url' => '<string>',
'notes' => '<string>',
'status' => '<string>',
'is_tenant' => true,
'is_active' => true,
'phone' => '<string>',
'email' => 'jsmith@example.com',
'secondary_phone' => '<string>',
'domain' => '<string>',
'authorised_domains' => '<string>',
'meta' => [
'<string>'
],
'address' => [
'address_line_1' => '<string>',
'address_line_2' => '<string>',
'address_line_3' => '<string>',
'company' => '<string>',
'is_default' => true,
'latitude' => 123,
'longitude' => 123,
'city' => '<string>',
'postcode' => '<string>',
'state' => '<string>',
'country' => '<string>',
'notes' => '<string>',
'iso' => '<string>',
'iso_state' => '<string>'
],
'locations' => [
123
],
'custom_fields' => [
[
'namespace' => '<string>',
'handle' => '<string>',
'value' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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.{tenant}.getomneo.com/api/v3/organisations"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"handle\": \"<string>\",\n \"description\": \"<string>\",\n \"short_description\": \"<string>\",\n \"icon\": \"<string>\",\n \"image_url\": \"<string>\",\n \"notes\": \"<string>\",\n \"status\": \"<string>\",\n \"is_tenant\": true,\n \"is_active\": true,\n \"phone\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"secondary_phone\": \"<string>\",\n \"domain\": \"<string>\",\n \"authorised_domains\": \"<string>\",\n \"meta\": [\n \"<string>\"\n ],\n \"address\": {\n \"address_line_1\": \"<string>\",\n \"address_line_2\": \"<string>\",\n \"address_line_3\": \"<string>\",\n \"company\": \"<string>\",\n \"is_default\": true,\n \"latitude\": 123,\n \"longitude\": 123,\n \"city\": \"<string>\",\n \"postcode\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"notes\": \"<string>\",\n \"iso\": \"<string>\",\n \"iso_state\": \"<string>\"\n },\n \"locations\": [\n 123\n ],\n \"custom_fields\": [\n {\n \"namespace\": \"<string>\",\n \"handle\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
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.{tenant}.getomneo.com/api/v3/organisations")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"handle\": \"<string>\",\n \"description\": \"<string>\",\n \"short_description\": \"<string>\",\n \"icon\": \"<string>\",\n \"image_url\": \"<string>\",\n \"notes\": \"<string>\",\n \"status\": \"<string>\",\n \"is_tenant\": true,\n \"is_active\": true,\n \"phone\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"secondary_phone\": \"<string>\",\n \"domain\": \"<string>\",\n \"authorised_domains\": \"<string>\",\n \"meta\": [\n \"<string>\"\n ],\n \"address\": {\n \"address_line_1\": \"<string>\",\n \"address_line_2\": \"<string>\",\n \"address_line_3\": \"<string>\",\n \"company\": \"<string>\",\n \"is_default\": true,\n \"latitude\": 123,\n \"longitude\": 123,\n \"city\": \"<string>\",\n \"postcode\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"notes\": \"<string>\",\n \"iso\": \"<string>\",\n \"iso_state\": \"<string>\"\n },\n \"locations\": [\n 123\n ],\n \"custom_fields\": [\n {\n \"namespace\": \"<string>\",\n \"handle\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.{tenant}.getomneo.com/api/v3/organisations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"handle\": \"<string>\",\n \"description\": \"<string>\",\n \"short_description\": \"<string>\",\n \"icon\": \"<string>\",\n \"image_url\": \"<string>\",\n \"notes\": \"<string>\",\n \"status\": \"<string>\",\n \"is_tenant\": true,\n \"is_active\": true,\n \"phone\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"secondary_phone\": \"<string>\",\n \"domain\": \"<string>\",\n \"authorised_domains\": \"<string>\",\n \"meta\": [\n \"<string>\"\n ],\n \"address\": {\n \"address_line_1\": \"<string>\",\n \"address_line_2\": \"<string>\",\n \"address_line_3\": \"<string>\",\n \"company\": \"<string>\",\n \"is_default\": true,\n \"latitude\": 123,\n \"longitude\": 123,\n \"city\": \"<string>\",\n \"postcode\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"notes\": \"<string>\",\n \"iso\": \"<string>\",\n \"iso_state\": \"<string>\"\n },\n \"locations\": [\n 123\n ],\n \"custom_fields\": [\n {\n \"namespace\": \"<string>\",\n \"handle\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 123,
"name": "<string>",
"handle": "<string>",
"description": "<string>",
"short_description": "<string>",
"icon": "<string>",
"image_url": "<string>",
"notes": "<string>",
"type": "<string>",
"status": "<string>",
"is_tenant": 123,
"is_active": 123,
"phone": "<string>",
"email": "<string>",
"secondary_phone": "<string>",
"domain": "<string>",
"authorised_domains": [
"<unknown>"
],
"meta": [
"<unknown>"
],
"locations": [
{
"id": 123,
"type": "<string>",
"name": "<string>",
"handle": "<string>",
"description": "<string>",
"phone": "<string>",
"email": "<string>",
"timezone": "<string>",
"external_id": "<string>",
"external_code": "<string>",
"is_published": true,
"is_permanently_closed": true,
"address": {
"id": 123,
"address_line_1": "<string>",
"address_line_2": "<string>",
"address_line_3": "<string>",
"company": "<string>",
"latitude": 123,
"longitude": 123,
"city": "<string>",
"postcode": "<string>",
"state": "<string>",
"country": "<string>",
"notes": "<string>",
"external_id": "<string>",
"is_default": true,
"created_at": "<string>",
"updated_at": "<string>",
"meta": [
"<unknown>"
],
"name": "<string>",
"type": "<string>",
"phone": "<string>",
"iso": "<string>",
"iso_state": "<string>",
"profile_id": "<string>",
"custom_fields": {}
},
"normal_hours": [
[
"<unknown>"
]
],
"special_hours": [
[
"<unknown>"
]
],
"tags": [
"<string>"
],
"custom_fields": {},
"icon": "<string>",
"country_iso_3": "<string>",
"image_url": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"departments": [
{
"id": 123,
"name": "<string>",
"handle": "<string>",
"external_id": "<string>",
"external_code": "<string>",
"description": "<string>",
"short_description": "<string>",
"url": "<string>",
"image_url": "<string>",
"internal_note": "<string>",
"meta": [
"<unknown>"
],
"brand_id": 123,
"location_id": 123,
"brand": {
"name": "<string>",
"handle": "<string>"
},
"created_at": "<string>",
"updated_at": "<string>"
}
]
}
],
"address": {
"id": 123,
"address_line_1": "<string>",
"address_line_2": "<string>",
"address_line_3": "<string>",
"company": "<string>",
"latitude": 123,
"longitude": 123,
"city": "<string>",
"postcode": "<string>",
"state": "<string>",
"country": "<string>",
"notes": "<string>",
"external_id": "<string>",
"is_default": true,
"created_at": "<string>",
"updated_at": "<string>",
"meta": [
"<unknown>"
],
"name": "<string>",
"type": "<string>",
"phone": "<string>",
"iso": "<string>",
"iso_state": "<string>",
"profile_id": "<string>",
"custom_fields": {}
},
"custom_fields": {},
"created_at": "<string>",
"updated_at": "<string>"
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>",
"errors": {}
}Body
application/json
Available options:
company, stockist, brand, organisation, group, school, club, other Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
Organisation
Show child attributes
Show child attributes
⌘I