> For the complete documentation index, see [llms.txt](https://guide.fariaedu.com/integrations-portal/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://guide.fariaedu.com/integrations-portal/schoolsbuddy/public-rest-apis/integrations.md).

# Integrations

## GET /api/v1/Integrations/isams/{organisationId}

> Gets the iSAMS integration configuration for an organisation.

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"servers":[{"url":"https://publicapi-eu.schoolsbuddy.net","description":"EMEA Public Api server"},{"url":"https://publicapi-asia.schoolsbuddy.net","description":"Asia Public Api server"},{"url":"https://publicapi-us.schoolsbuddy.net","description":"US Public Api server"},{"url":"https://publicapi.schoolsbuddy.cn","description":"China Public Api server"},{"url":"https://identity-eu.schoolsbuddy.net","description":"EMEA Identity server"},{"url":"https://identity-asia.schoolsbuddy.net","description":"Asia Identity server"},{"url":"https://identity-us.schoolsbuddy.net","description":"US Identity server"},{"url":"https://accounts.schoolsbuddy.cn","description":"China Identity server"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","description":"Type \"Bearer\" followed by a space and a token.","name":"Authorization","in":"header"}},"schemas":{"IsamsConfigResponseDto":{"type":"object","properties":{"orgId":{"type":"string","nullable":true},"importEnabled":{"type":"boolean"},"url":{"type":"string","nullable":true},"parentContactTypes":{"type":"array","items":{"type":"string"},"nullable":true},"importFlags":{"$ref":"#/components/schemas/IsamsImportFlagsDto"}},"additionalProperties":false},"IsamsImportFlagsDto":{"type":"object","properties":{"allMergesCorrespondenceOnly":{"type":"boolean"},"billingOrAllMergesOnly":{"type":"boolean"},"ignoreForms":{"type":"boolean"},"ignoreHouses":{"type":"boolean"},"ignoreSubjects":{"type":"boolean"},"ignoreYears":{"type":"boolean"},"parentalResponsibilityOnly":{"type":"boolean"}},"additionalProperties":false},"ErrorResponse":{"type":"object","properties":{"code":{"type":"string","description":"Gets or sets the machine-readable error code (e.g.\r\n`VALIDATION_FAILED`, `RESOURCE_NOT_FOUND`,\r\n`INTERNAL_ERROR`) per cross-cutting-design.md §5.1.","nullable":true},"error":{"type":"string","description":"Gets or sets the human-readable error message.","nullable":true}},"additionalProperties":false,"description":"Structured body for 4xx / 5xx responses on the new Public API surface:\r\na machine-readable SchoolsBuddy.PublicAPI.Models.ErrorResponse.Code plus a human-readable\r\nSchoolsBuddy.PublicAPI.Models.ErrorResponse.Error. See cross-cutting-design.md §5.3. This is additive —\r\nexisting endpoints continue returning their legacy plain-string /\r\nModelState shapes until migrated by their per-controller ticket."}}},"paths":{"/api/v1/Integrations/isams/{organisationId}":{"get":{"tags":["Integrations"],"summary":"Gets the iSAMS integration configuration for an organisation.","parameters":[{"name":"organisationId","in":"path","description":"Organisation identifier (route segment).","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IsamsConfigResponseDto"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## PATCH /api/v1/Integrations/isams/{organisationId}

> Updates one or more iSAMS integration configuration settings for an organisation.

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"servers":[{"url":"https://publicapi-eu.schoolsbuddy.net","description":"EMEA Public Api server"},{"url":"https://publicapi-asia.schoolsbuddy.net","description":"Asia Public Api server"},{"url":"https://publicapi-us.schoolsbuddy.net","description":"US Public Api server"},{"url":"https://publicapi.schoolsbuddy.cn","description":"China Public Api server"},{"url":"https://identity-eu.schoolsbuddy.net","description":"EMEA Identity server"},{"url":"https://identity-asia.schoolsbuddy.net","description":"Asia Identity server"},{"url":"https://identity-us.schoolsbuddy.net","description":"US Identity server"},{"url":"https://accounts.schoolsbuddy.cn","description":"China Identity server"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","description":"Type \"Bearer\" followed by a space and a token.","name":"Authorization","in":"header"}},"schemas":{"IsamsConfigPatchRequestDto":{"type":"object","properties":{"importEnabled":{"type":"boolean","nullable":true},"url":{"type":"string","nullable":true},"parentContactTypes":{"type":"array","items":{"type":"string"},"nullable":true},"importFlags":{"$ref":"#/components/schemas/IsamsImportFlagsPatchDto"}},"additionalProperties":false},"IsamsImportFlagsPatchDto":{"type":"object","properties":{"allMergesCorrespondenceOnly":{"type":"boolean","nullable":true},"billingOrAllMergesOnly":{"type":"boolean","nullable":true},"ignoreForms":{"type":"boolean","nullable":true},"ignoreHouses":{"type":"boolean","nullable":true},"ignoreSubjects":{"type":"boolean","nullable":true},"ignoreYears":{"type":"boolean","nullable":true},"parentalResponsibilityOnly":{"type":"boolean","nullable":true}},"additionalProperties":false},"IsamsConfigResponseDto":{"type":"object","properties":{"orgId":{"type":"string","nullable":true},"importEnabled":{"type":"boolean"},"url":{"type":"string","nullable":true},"parentContactTypes":{"type":"array","items":{"type":"string"},"nullable":true},"importFlags":{"$ref":"#/components/schemas/IsamsImportFlagsDto"}},"additionalProperties":false},"IsamsImportFlagsDto":{"type":"object","properties":{"allMergesCorrespondenceOnly":{"type":"boolean"},"billingOrAllMergesOnly":{"type":"boolean"},"ignoreForms":{"type":"boolean"},"ignoreHouses":{"type":"boolean"},"ignoreSubjects":{"type":"boolean"},"ignoreYears":{"type":"boolean"},"parentalResponsibilityOnly":{"type":"boolean"}},"additionalProperties":false},"ErrorResponse":{"type":"object","properties":{"code":{"type":"string","description":"Gets or sets the machine-readable error code (e.g.\r\n`VALIDATION_FAILED`, `RESOURCE_NOT_FOUND`,\r\n`INTERNAL_ERROR`) per cross-cutting-design.md §5.1.","nullable":true},"error":{"type":"string","description":"Gets or sets the human-readable error message.","nullable":true}},"additionalProperties":false,"description":"Structured body for 4xx / 5xx responses on the new Public API surface:\r\na machine-readable SchoolsBuddy.PublicAPI.Models.ErrorResponse.Code plus a human-readable\r\nSchoolsBuddy.PublicAPI.Models.ErrorResponse.Error. See cross-cutting-design.md §5.3. This is additive —\r\nexisting endpoints continue returning their legacy plain-string /\r\nModelState shapes until migrated by their per-controller ticket."}}},"paths":{"/api/v1/Integrations/isams/{organisationId}":{"patch":{"tags":["Integrations"],"summary":"Updates one or more iSAMS integration configuration settings for an organisation.","parameters":[{"name":"organisationId","in":"path","description":"Organisation identifier (route segment).","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"description":"The partial-update payload.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IsamsConfigPatchRequestDto"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IsamsConfigResponseDto"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```