Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Contacts

Get contacts with filters.

get
/api/v1/Contacts
Authorizations
AuthorizationstringRequired

Type "Bearer" followed by a space and a token.

Query parameters
IncludeArchivedbooleanOptional
ContactTypestring · enumOptionalPossible values:
SearchstringOptional
PageNumberinteger · int32 · min: 1 · max: 2147483647Optional
PageSizeinteger · int32 · min: 1 · max: 2000Optional
OrganisationIdsinteger · int32[]Optional
Responses
200

OK

application/json
isSuccessbooleanOptional
errorsstring[] · nullableOptional
messageTranslationParametersany · nullableOptional
pageNumberinteger · int32Optional
pageSizeinteger · int32Optional
firstPagestring · uri · nullableOptional
lastPagestring · uri · nullableOptional
totalPagesinteger · int32Optional
totalRecordsinteger · int32Optional
nextPagestring · uri · nullableOptional
previousPagestring · uri · nullableOptional
baseUristring · uri · nullableOptional
get/api/v1/Contacts
GET /api/v1/Contacts HTTP/1.1
Host: publicapi-eu.schoolsbuddy.net
Authorization: YOUR_API_KEY
Accept: */*

{
  "isSuccess": true,
  "errors": [
    "text"
  ],
  "messageTranslationParameters": null,
  "data": [
    {
      "id": 1,
      "organisationId": 1,
      "contactId": "text",
      "title": "text",
      "lastName": "text",
      "firstName": "text",
      "emailAddress": "text",
      "mobilePhoneNumber": "text",
      "phoneNumber": "text",
      "streetAddress": "text",
      "streetAddress2": "text",
      "city": "text",
      "state": "text",
      "country": "text",
      "postalCode": "text",
      "relatedPeople": [
        {
          "id": 1,
          "firstName": "text",
          "lastName": "text",
          "isArchived": true,
          "vban": "text",
          "isParent": true,
          "isBillingContact": true,
          "isReportContact": true,
          "isCommunicationContact": true,
          "isEmergencyContact": true
        }
      ],
      "createdAt": "2026-01-01T00:00:00.000Z",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "isArchived": true,
      "updatable": true
    }
  ],
  "pageNumber": 1,
  "pageSize": 1,
  "firstPage": "https://example.com",
  "lastPage": "https://example.com",
  "totalPages": 1,
  "totalRecords": 1,
  "nextPage": "https://example.com",
  "previousPage": "https://example.com",
  "baseUri": "https://example.com",
  "searchParameters": [
    {
      "key": "text",
      "value": "text"
    }
  ]
}

Create a new contact.

post
/api/v1/Contacts
Authorizations
AuthorizationstringRequired

Type "Bearer" followed by a space and a token.

Query parameters
organisationIdinteger · int32Optional
Body
contactIdstring · nullableOptional
titlestring · nullableOptional
mobilePhoneNumberstring · nullableOptional
phoneNumberstring · nullableOptional
streetAddressstring · nullableOptional
streetAddress2string · nullableOptional
citystring · nullableOptional
statestring · nullableOptional
countrystring · nullableOptional
postalCodestring · nullableOptional
isArchivedbooleanOptional
lastNamestring · min: 1Required
firstNamestring · min: 1Required
emailAddressstring · email · min: 1Required
Responses
201

Created

application/json
idinteger · int32Optional
organisationIdinteger · int32Optional
contactIdstring · nullableOptional
titlestring · nullableOptional
lastNamestring · nullableOptional
firstNamestring · nullableOptional
emailAddressstring · nullableOptional
mobilePhoneNumberstring · nullableOptional
phoneNumberstring · nullableOptional
streetAddressstring · nullableOptional
streetAddress2string · nullableOptional
citystring · nullableOptional
statestring · nullableOptional
countrystring · nullableOptional
postalCodestring · nullableOptional
createdAtstring · date-timeOptional
updatedAtstring · date-time · nullableOptional
isArchivedbooleanOptional
updatablebooleanOptional
post/api/v1/Contacts
POST /api/v1/Contacts HTTP/1.1
Host: publicapi-eu.schoolsbuddy.net
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 283

{
  "contactId": "text",
  "title": "text",
  "mobilePhoneNumber": "text",
  "phoneNumber": "text",
  "streetAddress": "text",
  "streetAddress2": "text",
  "city": "text",
  "state": "text",
  "country": "text",
  "postalCode": "text",
  "isArchived": true,
  "lastName": "text",
  "firstName": "text",
  "emailAddress": "name@gmail.com"
}
{
  "id": 1,
  "organisationId": 1,
  "contactId": "text",
  "title": "text",
  "lastName": "text",
  "firstName": "text",
  "emailAddress": "text",
  "mobilePhoneNumber": "text",
  "phoneNumber": "text",
  "streetAddress": "text",
  "streetAddress2": "text",
  "city": "text",
  "state": "text",
  "country": "text",
  "postalCode": "text",
  "relatedPeople": [
    {
      "id": 1,
      "firstName": "text",
      "lastName": "text",
      "isArchived": true,
      "vban": "text",
      "isParent": true,
      "isBillingContact": true,
      "isReportContact": true,
      "isCommunicationContact": true,
      "isEmergencyContact": true
    }
  ],
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z",
  "isArchived": true,
  "updatable": true
}

Get contact by Id.

get
/api/v1/Contacts/{id}
Authorizations
AuthorizationstringRequired

Type "Bearer" followed by a space and a token.

Path parameters
idinteger · int32Required

Contact Id

Query parameters
organisationIdinteger · int32Optional

Organisation Id (optional query parameter)

Responses
200

OK

application/json
idinteger · int32Optional
organisationIdinteger · int32Optional
contactIdstring · nullableOptional
titlestring · nullableOptional
lastNamestring · nullableOptional
firstNamestring · nullableOptional
emailAddressstring · nullableOptional
mobilePhoneNumberstring · nullableOptional
phoneNumberstring · nullableOptional
streetAddressstring · nullableOptional
streetAddress2string · nullableOptional
citystring · nullableOptional
statestring · nullableOptional
countrystring · nullableOptional
postalCodestring · nullableOptional
createdAtstring · date-timeOptional
updatedAtstring · date-time · nullableOptional
isArchivedbooleanOptional
updatablebooleanOptional
get/api/v1/Contacts/{id}
GET /api/v1/Contacts/{id} HTTP/1.1
Host: publicapi-eu.schoolsbuddy.net
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": 1,
  "organisationId": 1,
  "contactId": "text",
  "title": "text",
  "lastName": "text",
  "firstName": "text",
  "emailAddress": "text",
  "mobilePhoneNumber": "text",
  "phoneNumber": "text",
  "streetAddress": "text",
  "streetAddress2": "text",
  "city": "text",
  "state": "text",
  "country": "text",
  "postalCode": "text",
  "relatedPeople": [
    {
      "id": 1,
      "firstName": "text",
      "lastName": "text",
      "isArchived": true,
      "vban": "text",
      "isParent": true,
      "isBillingContact": true,
      "isReportContact": true,
      "isCommunicationContact": true,
      "isEmergencyContact": true
    }
  ],
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z",
  "isArchived": true,
  "updatable": true
}

Update an existing contact.

put
/api/v1/Contacts/{id}
Authorizations
AuthorizationstringRequired

Type "Bearer" followed by a space and a token.

Path parameters
idinteger · int32Required
Query parameters
organisationIdinteger · int32Optional
Body
contactIdstring · nullableOptional
titlestring · nullableOptional
lastNamestring · nullableOptional
firstNamestring · nullableOptional
emailAddressstring · email · nullableOptional
mobilePhoneNumberstring · nullableOptional
phoneNumberstring · nullableOptional
streetAddressstring · nullableOptional
streetAddress2string · nullableOptional
citystring · nullableOptional
statestring · nullableOptional
countrystring · nullableOptional
postalCodestring · nullableOptional
isArchivedbooleanOptional
Responses
200

OK

application/json
idinteger · int32Optional
organisationIdinteger · int32Optional
contactIdstring · nullableOptional
titlestring · nullableOptional
lastNamestring · nullableOptional
firstNamestring · nullableOptional
emailAddressstring · nullableOptional
mobilePhoneNumberstring · nullableOptional
phoneNumberstring · nullableOptional
streetAddressstring · nullableOptional
streetAddress2string · nullableOptional
citystring · nullableOptional
statestring · nullableOptional
countrystring · nullableOptional
postalCodestring · nullableOptional
createdAtstring · date-timeOptional
updatedAtstring · date-time · nullableOptional
isArchivedbooleanOptional
updatablebooleanOptional
put/api/v1/Contacts/{id}
PUT /api/v1/Contacts/{id} HTTP/1.1
Host: publicapi-eu.schoolsbuddy.net
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 283

{
  "contactId": "text",
  "title": "text",
  "lastName": "text",
  "firstName": "text",
  "emailAddress": "name@gmail.com",
  "mobilePhoneNumber": "text",
  "phoneNumber": "text",
  "streetAddress": "text",
  "streetAddress2": "text",
  "city": "text",
  "state": "text",
  "country": "text",
  "postalCode": "text",
  "isArchived": true
}
{
  "id": 1,
  "organisationId": 1,
  "contactId": "text",
  "title": "text",
  "lastName": "text",
  "firstName": "text",
  "emailAddress": "text",
  "mobilePhoneNumber": "text",
  "phoneNumber": "text",
  "streetAddress": "text",
  "streetAddress2": "text",
  "city": "text",
  "state": "text",
  "country": "text",
  "postalCode": "text",
  "relatedPeople": [
    {
      "id": 1,
      "firstName": "text",
      "lastName": "text",
      "isArchived": true,
      "vban": "text",
      "isParent": true,
      "isBillingContact": true,
      "isReportContact": true,
      "isCommunicationContact": true,
      "isEmergencyContact": true
    }
  ],
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z",
  "isArchived": true,
  "updatable": true
}

Bulk archive or unarchive contacts.

post
/api/v1/Contacts/BulkArchive
Authorizations
AuthorizationstringRequired

Type "Bearer" followed by a space and a token.

Body
organisationIdinteger · int32 · nullableOptional
archivebooleanOptional
idsinteger · int32[] · min: 1Required
Responses
200

OK

No content
post/api/v1/Contacts/BulkArchive
POST /api/v1/Contacts/BulkArchive HTTP/1.1
Host: publicapi-eu.schoolsbuddy.net
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "organisationId": 1,
  "archive": true,
  "ids": [
    1
  ]
}
No content
PreviousClass
NextEvent Categories

Last updated