Organizations
Get public profile
Gets the Community-App public profile for the given organization ID. Returns the profile, or null if the organization is not public.
Permissions
Send an API key of the organization in the path, using the X-API-Key header.
Who may call it
- Requires organization authentication.
- Requires the
organization.readpermission.
Request
Path parameters
-
organizationIdidrequired
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
--request GET 'https://cloud.campai.com/api/connect/organizations/YOUR_ORGANIZATION_ID/public-profile' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/connect/organizations/YOUR_ORGANIZATION_ID/public-profile", {
method: "GET",
headers: {
"X-API-Key": "YOUR_API_KEY"
},
redirect: 'error',
signal: AbortSignal.timeout(30_000),
});
if (!response.ok) throw new Error(`campai HTTP ${response.status}`);
const text = await response.text();
const result = text ? JSON.parse(text) : null;
console.log(JSON.stringify(result, null, 2));<?php
$context = stream_context_create(['http' => [
'method' => 'GET',
'header' => [
'X-API-Key: YOUR_API_KEY',
],
'timeout' => 30,
'follow_location' => 0,
'ignore_errors' => true,
]]);
$text = @file_get_contents('https://cloud.campai.com/api/connect/organizations/YOUR_ORGANIZATION_ID/public-profile', false, $context);
preg_match('/^HTTP\/\S+ (\d{3})/', $http_response_header[0] ?? '', $match);
$status = (int) ($match[1] ?? 0);
if ($text === false || $status < 200 || $status >= 300) {
throw new RuntimeException("campai HTTP $status (0 means no response)");
}
$result = $text === '' ? null : json_decode($text, true, 512, JSON_THROW_ON_ERROR);
echo json_encode($result, JSON_PRETTY_PRINT | JSON_THROW_ON_ERROR), PHP_EOL;
Response
200 Successful response
Content-Type: application/json
-
introductionstring1–140 characters
-
aboutstring1–4000 characters
-
emailstring -
phonestring | string · phone -
coverobjectnullable4 properties
-
resourcestringat least 1 characters
-
fileNamestringat most 128 characters
-
contentTypestringat most 75 characters
-
fileSizeBytesintegerat least 0
-
-
sitesobject[]1–64 items
5 properties
-
namestring1–24 characters
-
descriptionstringat most 280 characters
-
addressobject7 properties
-
countrystring -
statestring -
zipstringat most 10 characters
-
citystringat most 45 characters
-
addressLinestringat most 45 characters
-
details1stringat most 45 characters
-
details2stringat most 45 characters
-
-
openingobjectnullable2 properties
-
hoursobject2 properties
-
fromobject2 properties
-
hoursinteger0–23
-
minutesinteger0–59
-
-
toobject2 properties
-
hoursinteger0–23
-
minutesinteger0–59
-
-
-
daysstring[]1–7 items
montuewedthufrisatsun
-
-
locationobjectnullable2 properties
-
latitudenumber-90–90
-
longitudenumber-180–180
-
-
Response200
{
"introduction": "string",
"about": "string",
"email": "",
"phone": "",
"cover": {
"resource": "string"
},
"sites": [
{
"name": "string",
"description": "string",
"address": {
"country": "string",
"zip": "string",
"city": "string",
"addressLine": "string"
},
"opening": {
"hours": {
"from": {
"hours": 0,
"minutes": 0
},
"to": {
"hours": 0,
"minutes": 0
}
},
"days": [
"mon"
]
},
"location": {
"latitude": -90,
"longitude": -180
}
}
]
}
Errors
Other errors
| Status | Error | When |
|---|---|---|
| 404 | No fixed message | Returns HTTP 404 if the organization is not found. |
Errors nearly every request can meet are listed under Errors.