Clinic Settings

Read clinic settings data

GET /clinics/{clinicId}/settings

Path Parameters

clinicIdstringrequired

Responses

application/json

200Successful response

clinicobjectrequired

invitationsobject[]required

locationsobject[]required

rolesobject[]required

staffobject[]required

curl --request GET \ \
  --url 'https://api.joinaffinityai.com/clinics/{clinicId}/settings' \
  --header 'Authorization: Bearer <token>'

{
  "clinic": {
    "clinicId": "<string>",
    "displayName": "<string>",
    "legalName": "<string>",
    "logoUrl": "<string>",
    "organizationId": "<string>",
    "organizationName": "<string>",
    "organizationSlug": "<string>"
  },
  "invitations": [
    {
      "email": "<string>",
      "expiresAt": "<string>",
      "id": "<string>",
      "role": "<string>",
      "status": "<string>"
    }
  ],
  "locations": [
    {
      "clinicId": "<string>",
      "id": "<string>",
      "name": "<string>",
      "timezone": "<string>"
    }
  ],
  "roles": [
    {
      "id": "<string>",
      "isProvider": true,
      "name": "<string>",
      "permissions": [
        "<string>"
      ],
      "slug": "<string>"
    }
  ],
  "staff": [
    {
      "email": "<string>",
      "name": "<string>",
      "role": "<string>",
      "roleName": "<string>",
      "status": "<string>",
      "userId": "<string>"
    }
  ]
}