Get

GET /api/organizations/{id}

Http bearer

Fetch an organization

Path parameters

id string Required

Responses

200 application/json

Successful Response
Hide response attributes Show response attributes object
- name string Required
  
  Minimum length is 2, maximum length is 100.
- email string Required
  
  Minimum length is 2, maximum length is 255.
- primaryDomain string Required
  
  Minimum length is 4, maximum length is 253.
- id string Required
- alias string Required
  
  Minimum length is 2, maximum length is 30.
- labels array[object] Required
  
  Hide labels attributes Show labels attributes object
  
  name string Required
  
  Minimum length is 1, maximum length is 50.
  
  bgColor string Required
  
  Maximum length is 20.
  
  id string Required
  
  resourceType string Required
  
  createdAt string(date-time) Required
- settings object | null Required
  
  Hide settings attributes Show settings attributes object | null
  
  shiftReports object Required
  
  Hide shiftReports attributes Show shiftReports attributes object
  
  enabled boolean Required
  
  uiSchema object | null
  
  email object Required
  
  Hide email attributes Show email attributes object
  
  enabled boolean Required
  
  signature string | null
  
  Minimum length is 2, maximum length is 5000.
  
  sms object Required
  
  Hide sms attribute Show sms attribute object
  
  enabled boolean Required
  
  webPush object Required
  
  Hide webPush attributes Show webPush attributes object
  
  enabled boolean Required
  
  vapidPublicKey string Required
422 application/json

Validation Error
Hide response attribute Show response attribute object
- detail array[object]
  
  Hide detail attributes Show detail attributes object
  
  loc array[string | integer] Required
  
  msg string Required
  
  type string Required

GET /api/organizations/{id}

curl \
 -X GET https://metropolitanabogota.org/api/organizations/{id} \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "name": "string",
  "email": "string",
  "primaryDomain": "string",
  "id": "string",
  "alias": "string",
  "labels": [
    {
      "name": "string",
      "bgColor": "string",
      "id": "string",
      "resourceType": "string",
      "createdAt": "2024-05-04T09:42:00+00:00"
    }
  ],
  "settings": {
    "shiftReports": {
      "enabled": true,
      "uiSchema": {}
    },
    "email": {
      "enabled": true,
      "signature": "string"
    },
    "sms": {
      "enabled": true
    },
    "webPush": {
      "enabled": true,
      "vapidPublicKey": "string"
    }
  }
}

Response examples (422)

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}