Skip to content
campaiDeveloper
campai.com

Organizations

GET/connect/organizations/{organizationId}/public-profileReads only

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.read permission.

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'

Response

200 Successful response

Content-Type: application/json

  • introductionstring

    1–140 characters

  • aboutstring

    1–4000 characters

  • emailstring
  • phonestring | string · phone
  • coverobjectnullable
    4 properties
    • resourcestring

      at least 1 characters

    • fileNamestring

      at most 128 characters

    • contentTypestring

      at most 75 characters

    • fileSizeBytesinteger

      at least 0

  • sitesobject[]

    1–64 items

    5 properties
    • namestring

      1–24 characters

    • descriptionstring

      at most 280 characters

    • addressobject
      7 properties
      • countrystring
      • statestring
      • zipstring

        at most 10 characters

      • citystring

        at most 45 characters

      • addressLinestring

        at most 45 characters

      • details1string

        at most 45 characters

      • details2string

        at most 45 characters

    • openingobjectnullable
      2 properties
      • hoursobject
        2 properties
        • fromobject
          2 properties
          • hoursinteger

            0–23

          • minutesinteger

            0–59

        • toobject
          2 properties
          • hoursinteger

            0–23

          • minutesinteger

            0–59

      • daysstring[]

        1–7 items

        mon tue wed thu fri sat sun
    • locationobjectnullable
      2 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

StatusErrorWhen
404No fixed messageReturns HTTP 404 if the organization is not found.

Errors nearly every request can meet are listed under Errors.