Get an organisation
curl --request GET \
--url http://localhost:3001/portal-api/organisations/{organisation_id} \
--header 'Authorization: <api-key>'import requests
url = "http://localhost:3001/portal-api/organisations/{organisation_id}"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('http://localhost:3001/portal-api/organisations/{organisation_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3001",
CURLOPT_URL => "http://localhost:3001/portal-api/organisations/{organisation_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <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"
"net/http"
"io"
)
func main() {
url := "http://localhost:3001/portal-api/organisations/{organisation_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:3001/portal-api/organisations/{organisation_id}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3001/portal-api/organisations/{organisation_id}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"CreatedAt": "2023-06-23 21:02",
"UpdatedAt": "2023-06-23 21:02",
"ID": 1,
"Name": "Default Organisation",
"Teams": [
{
"Default": true,
"ID": 1,
"Name": "Default Organisation All users"
}
],
"Users": [
{
"Active": true,
"Email": "admin@acme.com",
"First": "John",
"Last": "Doe",
"OrganisationID": 1,
"Role": "consumer-team-member",
"Provider": "password",
"ID": 1
}
]
}Organisations
Get an organisation
Get an organisation
GET
/
organisations
/
{organisation_id}
Get an organisation
curl --request GET \
--url http://localhost:3001/portal-api/organisations/{organisation_id} \
--header 'Authorization: <api-key>'import requests
url = "http://localhost:3001/portal-api/organisations/{organisation_id}"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('http://localhost:3001/portal-api/organisations/{organisation_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3001",
CURLOPT_URL => "http://localhost:3001/portal-api/organisations/{organisation_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <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"
"net/http"
"io"
)
func main() {
url := "http://localhost:3001/portal-api/organisations/{organisation_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:3001/portal-api/organisations/{organisation_id}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3001/portal-api/organisations/{organisation_id}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"CreatedAt": "2023-06-23 21:02",
"UpdatedAt": "2023-06-23 21:02",
"ID": 1,
"Name": "Default Organisation",
"Teams": [
{
"Default": true,
"ID": 1,
"Name": "Default Organisation All users"
}
],
"Users": [
{
"Active": true,
"Email": "admin@acme.com",
"First": "John",
"Last": "Doe",
"OrganisationID": 1,
"Role": "consumer-team-member",
"Provider": "password",
"ID": 1
}
]
}Authorizations
Path Parameters
UID of an organisation
Example:
2
Response
200 - application/json
OK
Date-time when a user is created
Pattern:
^\d{4}-\d{2}-\d{2} \d{2}:\d{2}$Example:
"2023-06-23 21:02"
Date-time when a user is updated the last time
Pattern:
^\d{4}-\d{2}-\d{2} \d{2}:\d{2}$Example:
"2023-06-23 21:02"
UID of an organisation
Example:
1
Name of an organisation
Example:
"Default Organisation"
Teams included in this organisation
Show child attributes
Show child attributes
Users that are included in this organisation. For newly created organisation this field will be an empty array
Show child attributes
Show child attributes
Was this page helpful?
⌘I