Search Guardians

Authorizations

Client-ID

string

header

required

Client-Secret

string

header

required

Query Parameters

limit

integer

default:50

The maximum number of Guardians to return (default: 50) when searching Guardians

offset

integer

default:0

The number of Guardians to skip before starting to return results (default: 0) when searching Guardians

Body

application/json

Request body

filter

object

required

Filter criteria to search for specific records

Show child attributes

filter.orCondition

boolean

required

OrCondition decides if this filter is within an OR-condition or AND-condition

filter.equals

object

Equality filters for Guardian

Show child attributes

filter.equals.id

string<uuid> | null

Unique identifier for the Guardian

filter.equals.meta

object

Metadata information for the Guardian

Show child attributes

filter.equals.meta.createdAt

string<date-time> | null

Timestamp when the resource was created

filter.equals.meta.createdBy

string<uuid> | null

User who created the resource

filter.equals.meta.updatedAt

string<date-time> | null

Timestamp when the resource was last updated

filter.equals.meta.updatedBy

string<uuid> | null

User who last updated the resource

Example:

{
  "createdAt": "2024-01-15T10:30:00Z",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2024-01-15T10:30:00Z",
  "updatedBy": "123e4567-e89b-12d3-a456-426614174000"
}

filter.equals.external

object

External is a reusable object that can be used to store external information about the guardian from another system, used for third-party integration tracking.

Show child attributes

filter.equals.external.sourceID

string | null

The ID of the external source

filter.equals.external.source

string | null

The source of the external information

Example:

{
  "sourceID": "example",
  "source": "example"
}

filter.equals.identityNumber

string | null

The identity number of the guardian, must be unique within the organization.

filter.equals.identityTemporary

boolean | null

If the identity number is temporary for the guardian

filter.equals.firstName

string | null

The first name of the guardian

filter.equals.lastName

string | null

The last name of the guardian

filter.equals.address

object

The address of the guardian

Show child attributes

filter.equals.address.postalAddress

string | null

The postal address of the address

filter.equals.address.postalCode

string | null

The postal code of the address

filter.equals.address.postalCity

string | null

The city of the address

filter.equals.address.countryCode

string | null

The country code of the address

filter.equals.address.municipalityCode

string | null

The municipality code of the address

Example:

{
  "postalAddress": "example",
  "postalCode": "example",
  "postalCity": "example",
  "countryCode": "example",
  "municipalityCode": "example"
}

filter.equals.emailAddress1

string | null

The email address of the guardian, will be used for communication with the guardian from the system and must be unique within the organization. Can be used to login to the system if password-authentication is enabled for the organization.

filter.equals.emailAddress2

string | null

The secondary email address of the guardian, will not be used within the system, but will be displayed for contact information.

filter.equals.phoneNumber1

string | null

The primary phone number of the guardian, will be used for communication with the guardian from the system.

filter.equals.phoneNumber2

string | null

The secondary phone number of the guardian, will not be used within the system, but will be displayed for contact information.

filter.equals.studentIDs

string<uuid> | null

The IDs of the students the guardian is responsible for.

Example:

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "meta": {
    "createdAt": "2024-01-15T10:30:00Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000",
    "updatedAt": "2024-01-15T10:30:00Z",
    "updatedBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "external": {
    "sourceID": "example",
    "source": "example"
  },
  "identityNumber": "example",
  "identityTemporary": true,
  "firstName": "example",
  "lastName": "example",
  "address": {
    "postalAddress": "example",
    "postalCode": "example",
    "postalCity": "example",
    "countryCode": "example",
    "municipalityCode": "example"
  },
  "emailAddress1": "example",
  "emailAddress2": "example",
  "phoneNumber1": "example",
  "phoneNumber2": "example",
  "studentIDs": "123e4567-e89b-12d3-a456-426614174000"
}

filter.notEquals

object

Inequality filters for Guardian

Show child attributes

filter.notEquals.id

string<uuid> | null

Unique identifier for the Guardian

filter.notEquals.meta

object

Metadata information for the Guardian

Show child attributes

filter.notEquals.meta.createdAt

string<date-time> | null

Timestamp when the resource was created

filter.notEquals.meta.createdBy

string<uuid> | null

User who created the resource

filter.notEquals.meta.updatedAt

string<date-time> | null

Timestamp when the resource was last updated

filter.notEquals.meta.updatedBy

string<uuid> | null

User who last updated the resource

Example:

{
  "createdAt": "2024-01-15T10:30:00Z",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2024-01-15T10:30:00Z",
  "updatedBy": "123e4567-e89b-12d3-a456-426614174000"
}

filter.notEquals.external

object

External is a reusable object that can be used to store external information about the guardian from another system, used for third-party integration tracking.

Show child attributes

filter.notEquals.external.sourceID

string | null

The ID of the external source

filter.notEquals.external.source

string | null

The source of the external information

Example:

{
  "sourceID": "example",
  "source": "example"
}

filter.notEquals.identityNumber

string | null

The identity number of the guardian, must be unique within the organization.

filter.notEquals.identityTemporary

boolean | null

If the identity number is temporary for the guardian

filter.notEquals.firstName

string | null

The first name of the guardian

filter.notEquals.lastName

string | null

The last name of the guardian

filter.notEquals.address

object

The address of the guardian

Show child attributes

filter.notEquals.address.postalAddress

string | null

The postal address of the address

filter.notEquals.address.postalCode

string | null

The postal code of the address

filter.notEquals.address.postalCity

string | null

The city of the address

filter.notEquals.address.countryCode

string | null

The country code of the address

filter.notEquals.address.municipalityCode

string | null

The municipality code of the address

Example:

{
  "postalAddress": "example",
  "postalCode": "example",
  "postalCity": "example",
  "countryCode": "example",
  "municipalityCode": "example"
}

filter.notEquals.emailAddress1

string | null

filter.notEquals.emailAddress2

string | null

The secondary email address of the guardian, will not be used within the system, but will be displayed for contact information.

filter.notEquals.phoneNumber1

string | null

The primary phone number of the guardian, will be used for communication with the guardian from the system.

filter.notEquals.phoneNumber2

string | null

The secondary phone number of the guardian, will not be used within the system, but will be displayed for contact information.

filter.notEquals.studentIDs

string<uuid> | null

The IDs of the students the guardian is responsible for.

Example:

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "meta": {
    "createdAt": "2024-01-15T10:30:00Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000",
    "updatedAt": "2024-01-15T10:30:00Z",
    "updatedBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "external": {
    "sourceID": "example",
    "source": "example"
  },
  "identityNumber": "example",
  "identityTemporary": true,
  "firstName": "example",
  "lastName": "example",
  "address": {
    "postalAddress": "example",
    "postalCode": "example",
    "postalCity": "example",
    "countryCode": "example",
    "municipalityCode": "example"
  },
  "emailAddress1": "example",
  "emailAddress2": "example",
  "phoneNumber1": "example",
  "phoneNumber2": "example",
  "studentIDs": "123e4567-e89b-12d3-a456-426614174000"
}

filter.greaterThan

object

Greater than filters for Guardian

Show child attributes

filter.greaterThan.meta

object

Metadata information for the Guardian

Show child attributes

filter.greaterThan.meta.createdAt

string<date-time> | null

Timestamp when the resource was created

filter.greaterThan.meta.updatedAt

string<date-time> | null

Timestamp when the resource was last updated

Example:

{
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z"
}

filter.greaterThan.external

object

External is a reusable object that can be used to store external information about the guardian from another system, used for third-party integration tracking.

filter.greaterThan.address

object

The address of the guardian

Example:

{
  "meta": {
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-01-15T10:30:00Z"
  }
}

filter.smallerThan

object

Smaller than filters for Guardian

Show child attributes

filter.smallerThan.meta

object

Metadata information for the Guardian

Show child attributes

filter.smallerThan.meta.createdAt

string<date-time> | null

Timestamp when the resource was created

filter.smallerThan.meta.updatedAt

string<date-time> | null

Timestamp when the resource was last updated

Example:

{
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z"
}

filter.smallerThan.external

object

External is a reusable object that can be used to store external information about the guardian from another system, used for third-party integration tracking.

filter.smallerThan.address

object

The address of the guardian

Example:

{
  "meta": {
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-01-15T10:30:00Z"
  }
}

filter.greaterOrEqual

object

Greater than or equal filters for Guardian

Show child attributes

filter.greaterOrEqual.meta

object

Metadata information for the Guardian

Show child attributes

filter.greaterOrEqual.meta.createdAt

string<date-time> | null

Timestamp when the resource was created

filter.greaterOrEqual.meta.updatedAt

string<date-time> | null

Timestamp when the resource was last updated

Example:

{
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z"
}

filter.greaterOrEqual.external

object

External is a reusable object that can be used to store external information about the guardian from another system, used for third-party integration tracking.

filter.greaterOrEqual.address

object

The address of the guardian

Example:

{
  "meta": {
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-01-15T10:30:00Z"
  }
}

filter.smallerOrEqual

object

Smaller than or equal filters for Guardian

Show child attributes

filter.smallerOrEqual.meta

object

Metadata information for the Guardian

Show child attributes

filter.smallerOrEqual.meta.createdAt

string<date-time> | null

Timestamp when the resource was created

filter.smallerOrEqual.meta.updatedAt

string<date-time> | null

Timestamp when the resource was last updated

Example:

{
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z"
}

filter.smallerOrEqual.external

object

External is a reusable object that can be used to store external information about the guardian from another system, used for third-party integration tracking.

filter.smallerOrEqual.address

object

The address of the guardian

Example:

{
  "meta": {
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-01-15T10:30:00Z"
  }
}

filter.contains

object

Contains filters for Guardian

Show child attributes

filter.contains.id

string<uuid>[]

Unique identifier for the Guardian

filter.contains.meta

object

Metadata information for the Guardian

Show child attributes

filter.contains.meta.createdBy

string<uuid>[]

User who created the resource

filter.contains.meta.updatedBy

string<uuid>[]

User who last updated the resource

Example:

{
  "createdBy": ["123e4567-e89b-12d3-a456-426614174000"],
  "updatedBy": ["123e4567-e89b-12d3-a456-426614174000"]
}

filter.contains.external

object

External is a reusable object that can be used to store external information about the guardian from another system, used for third-party integration tracking.

Show child attributes

filter.contains.external.sourceID

string[]

The ID of the external source

filter.contains.external.source

string[]

The source of the external information

Example:

{
  "sourceID": ["example"],
  "source": ["example"]
}

filter.contains.identityNumber

string[]

The identity number of the guardian, must be unique within the organization.

filter.contains.identityTemporary

boolean[]

If the identity number is temporary for the guardian

filter.contains.firstName

string[]

The first name of the guardian

filter.contains.lastName

string[]

The last name of the guardian

filter.contains.address

object

The address of the guardian

Show child attributes

filter.contains.address.postalAddress

string[]

The postal address of the address

filter.contains.address.postalCode

string[]

The postal code of the address

filter.contains.address.postalCity

string[]

The city of the address

filter.contains.address.countryCode

string[]

The country code of the address

filter.contains.address.municipalityCode

string[]

The municipality code of the address

Example:

{
  "postalAddress": ["example"],
  "postalCode": ["example"],
  "postalCity": ["example"],
  "countryCode": ["example"],
  "municipalityCode": ["example"]
}

filter.contains.emailAddress1

string[]

filter.contains.emailAddress2

string[]

The secondary email address of the guardian, will not be used within the system, but will be displayed for contact information.

filter.contains.phoneNumber1

string[]

The primary phone number of the guardian, will be used for communication with the guardian from the system.

filter.contains.phoneNumber2

string[]

The secondary phone number of the guardian, will not be used within the system, but will be displayed for contact information.

filter.contains.studentIDs

string<uuid>[]

The IDs of the students the guardian is responsible for.

Example:

{
  "id": ["123e4567-e89b-12d3-a456-426614174000"],
  "meta": {
    "createdBy": ["123e4567-e89b-12d3-a456-426614174000"],
    "updatedBy": ["123e4567-e89b-12d3-a456-426614174000"]
  },
  "external": {
    "sourceID": ["example"],
    "source": ["example"]
  },
  "identityNumber": ["example"],
  "identityTemporary": [true],
  "firstName": ["example"],
  "lastName": ["example"],
  "address": {
    "postalAddress": ["example"],
    "postalCode": ["example"],
    "postalCity": ["example"],
    "countryCode": ["example"],
    "municipalityCode": ["example"]
  },
  "emailAddress1": ["example"],
  "emailAddress2": ["example"],
  "phoneNumber1": ["example"],
  "phoneNumber2": ["example"],
  "studentIDs": ["123e4567-e89b-12d3-a456-426614174000"]
}

filter.notContains

object

Not contains filters for Guardian

Show child attributes

filter.notContains.id

string<uuid>[]

Unique identifier for the Guardian

filter.notContains.meta

object

Metadata information for the Guardian

Show child attributes

filter.notContains.meta.createdBy

string<uuid>[]

User who created the resource

filter.notContains.meta.updatedBy

string<uuid>[]

User who last updated the resource

Example:

{
  "createdBy": ["123e4567-e89b-12d3-a456-426614174000"],
  "updatedBy": ["123e4567-e89b-12d3-a456-426614174000"]
}

filter.notContains.external

object

External is a reusable object that can be used to store external information about the guardian from another system, used for third-party integration tracking.

Show child attributes

filter.notContains.external.sourceID

string[]

The ID of the external source

filter.notContains.external.source

string[]

The source of the external information

Example:

{
  "sourceID": ["example"],
  "source": ["example"]
}

filter.notContains.identityNumber

string[]

The identity number of the guardian, must be unique within the organization.

filter.notContains.identityTemporary

boolean[]

If the identity number is temporary for the guardian

filter.notContains.firstName

string[]

The first name of the guardian

filter.notContains.lastName

string[]

The last name of the guardian

filter.notContains.address

object

The address of the guardian

Show child attributes

filter.notContains.address.postalAddress

string[]

The postal address of the address

filter.notContains.address.postalCode

string[]

The postal code of the address

filter.notContains.address.postalCity

string[]

The city of the address

filter.notContains.address.countryCode

string[]

The country code of the address

filter.notContains.address.municipalityCode

string[]

The municipality code of the address

Example:

{
  "postalAddress": ["example"],
  "postalCode": ["example"],
  "postalCity": ["example"],
  "countryCode": ["example"],
  "municipalityCode": ["example"]
}

filter.notContains.emailAddress1

string[]

filter.notContains.emailAddress2

string[]

The secondary email address of the guardian, will not be used within the system, but will be displayed for contact information.

filter.notContains.phoneNumber1

string[]

The primary phone number of the guardian, will be used for communication with the guardian from the system.

filter.notContains.phoneNumber2

string[]

The secondary phone number of the guardian, will not be used within the system, but will be displayed for contact information.

filter.notContains.studentIDs

string<uuid>[]

The IDs of the students the guardian is responsible for.

Example:

{
  "id": ["123e4567-e89b-12d3-a456-426614174000"],
  "meta": {
    "createdBy": ["123e4567-e89b-12d3-a456-426614174000"],
    "updatedBy": ["123e4567-e89b-12d3-a456-426614174000"]
  },
  "external": {
    "sourceID": ["example"],
    "source": ["example"]
  },
  "identityNumber": ["example"],
  "identityTemporary": [true],
  "firstName": ["example"],
  "lastName": ["example"],
  "address": {
    "postalAddress": ["example"],
    "postalCode": ["example"],
    "postalCity": ["example"],
    "countryCode": ["example"],
    "municipalityCode": ["example"]
  },
  "emailAddress1": ["example"],
  "emailAddress2": ["example"],
  "phoneNumber1": ["example"],
  "phoneNumber2": ["example"],
  "studentIDs": ["123e4567-e89b-12d3-a456-426614174000"]
}

filter.like

object

LIKE filters for Guardian

Show child attributes

filter.like.meta

object

Metadata information for the Guardian

filter.like.external

object

External is a reusable object that can be used to store external information about the guardian from another system, used for third-party integration tracking.

Show child attributes

filter.like.external.sourceID

string | null

The ID of the external source

filter.like.external.source

string | null

The source of the external information

Example:

{
  "sourceID": "example",
  "source": "example"
}

filter.like.identityNumber

string | null

The identity number of the guardian, must be unique within the organization.

filter.like.firstName

string | null

The first name of the guardian

filter.like.lastName

string | null

The last name of the guardian

filter.like.address

object

The address of the guardian

Show child attributes

filter.like.address.postalAddress

string | null

The postal address of the address

filter.like.address.postalCode

string | null

The postal code of the address

filter.like.address.postalCity

string | null

The city of the address

filter.like.address.countryCode

string | null

The country code of the address

filter.like.address.municipalityCode

string | null

The municipality code of the address

Example:

{
  "postalAddress": "example",
  "postalCode": "example",
  "postalCity": "example",
  "countryCode": "example",
  "municipalityCode": "example"
}

filter.like.emailAddress1

string | null

filter.like.emailAddress2

string | null

The secondary email address of the guardian, will not be used within the system, but will be displayed for contact information.

filter.like.phoneNumber1

string | null

The primary phone number of the guardian, will be used for communication with the guardian from the system.

filter.like.phoneNumber2

string | null

The secondary phone number of the guardian, will not be used within the system, but will be displayed for contact information.

Example:

{
  "external": {
    "sourceID": "example",
    "source": "example"
  },
  "identityNumber": "example",
  "firstName": "example",
  "lastName": "example",
  "address": {
    "postalAddress": "example",
    "postalCode": "example",
    "postalCity": "example",
    "countryCode": "example",
    "municipalityCode": "example"
  },
  "emailAddress1": "example",
  "emailAddress2": "example",
  "phoneNumber1": "example",
  "phoneNumber2": "example"
}

filter.notLike

object

NOT LIKE filters for Guardian

Show child attributes

filter.notLike.meta

object

Metadata information for the Guardian

filter.notLike.external

object

External is a reusable object that can be used to store external information about the guardian from another system, used for third-party integration tracking.

Show child attributes

filter.notLike.external.sourceID

string | null

The ID of the external source

filter.notLike.external.source

string | null

The source of the external information

Example:

{
  "sourceID": "example",
  "source": "example"
}

filter.notLike.identityNumber

string | null

The identity number of the guardian, must be unique within the organization.

filter.notLike.firstName

string | null

The first name of the guardian

filter.notLike.lastName

string | null

The last name of the guardian

filter.notLike.address

object

The address of the guardian

Show child attributes

filter.notLike.address.postalAddress

string | null

The postal address of the address

filter.notLike.address.postalCode

string | null

The postal code of the address

filter.notLike.address.postalCity

string | null

The city of the address

filter.notLike.address.countryCode

string | null

The country code of the address

filter.notLike.address.municipalityCode

string | null

The municipality code of the address

Example:

{
  "postalAddress": "example",
  "postalCode": "example",
  "postalCity": "example",
  "countryCode": "example",
  "municipalityCode": "example"
}

filter.notLike.emailAddress1

string | null

filter.notLike.emailAddress2

string | null

The secondary email address of the guardian, will not be used within the system, but will be displayed for contact information.

filter.notLike.phoneNumber1

string | null

The primary phone number of the guardian, will be used for communication with the guardian from the system.

filter.notLike.phoneNumber2

string | null

The secondary phone number of the guardian, will not be used within the system, but will be displayed for contact information.

Example:

{
  "external": {
    "sourceID": "example",
    "source": "example"
  },
  "identityNumber": "example",
  "firstName": "example",
  "lastName": "example",
  "address": {
    "postalAddress": "example",
    "postalCode": "example",
    "postalCity": "example",
    "countryCode": "example",
    "municipalityCode": "example"
  },
  "emailAddress1": "example",
  "emailAddress2": "example",
  "phoneNumber1": "example",
  "phoneNumber2": "example"
}

filter.null

object

Null filters for Guardian

Show child attributes

filter.null.meta

object

Metadata information for the Guardian

Show child attributes

filter.null.meta.createdBy

boolean | null

User who created the resource

filter.null.meta.updatedAt

boolean | null

Timestamp when the resource was last updated

filter.null.meta.updatedBy

boolean | null

User who last updated the resource

Example:

{
  "createdBy": true,
  "updatedAt": true,
  "updatedBy": true
}

filter.null.external

object

External is a reusable object that can be used to store external information about the guardian from another system, used for third-party integration tracking.

Show child attributes

filter.null.external.sourceID

boolean | null

The ID of the external source

filter.null.external.source

boolean | null

The source of the external information

Example:

{ "sourceID": true, "source": true }

filter.null.address

object

The address of the guardian

Show child attributes

filter.null.address.postalAddress

boolean | null

The postal address of the address

filter.null.address.postalCode

boolean | null

The postal code of the address

filter.null.address.postalCity

boolean | null

The city of the address

filter.null.address.countryCode

boolean | null

The country code of the address

filter.null.address.municipalityCode

boolean | null

The municipality code of the address

Example:

{
  "postalAddress": true,
  "postalCode": true,
  "postalCity": true,
  "countryCode": true,
  "municipalityCode": true
}

filter.null.emailAddress1

boolean | null

filter.null.emailAddress2

boolean | null

The secondary email address of the guardian, will not be used within the system, but will be displayed for contact information.

filter.null.phoneNumber1

boolean | null

The primary phone number of the guardian, will be used for communication with the guardian from the system.

filter.null.phoneNumber2

boolean | null

The secondary phone number of the guardian, will not be used within the system, but will be displayed for contact information.

filter.null.studentIDs

boolean | null

The IDs of the students the guardian is responsible for.

Example:

{
  "meta": {
    "createdBy": true,
    "updatedAt": true,
    "updatedBy": true
  },
  "external": { "sourceID": true, "source": true },
  "address": {
    "postalAddress": true,
    "postalCode": true,
    "postalCity": true,
    "countryCode": true,
    "municipalityCode": true
  },
  "emailAddress1": true,
  "emailAddress2": true,
  "phoneNumber1": true,
  "phoneNumber2": true,
  "studentIDs": true
}

filter.notNull

object

Not null filters for Guardian

Show child attributes

filter.notNull.meta

object

Metadata information for the Guardian

Show child attributes

filter.notNull.meta.createdBy

boolean | null

User who created the resource

filter.notNull.meta.updatedAt

boolean | null

Timestamp when the resource was last updated

filter.notNull.meta.updatedBy

boolean | null

User who last updated the resource

Example:

{
  "createdBy": true,
  "updatedAt": true,
  "updatedBy": true
}

filter.notNull.external

object

External is a reusable object that can be used to store external information about the guardian from another system, used for third-party integration tracking.

Show child attributes

filter.notNull.external.sourceID

boolean | null

The ID of the external source

filter.notNull.external.source

boolean | null

The source of the external information

Example:

{ "sourceID": true, "source": true }

filter.notNull.address

object

The address of the guardian

Show child attributes

filter.notNull.address.postalAddress

boolean | null

The postal address of the address

filter.notNull.address.postalCode

boolean | null

The postal code of the address

filter.notNull.address.postalCity

boolean | null

The city of the address

filter.notNull.address.countryCode

boolean | null

The country code of the address

filter.notNull.address.municipalityCode

boolean | null

The municipality code of the address

Example:

{
  "postalAddress": true,
  "postalCode": true,
  "postalCity": true,
  "countryCode": true,
  "municipalityCode": true
}

filter.notNull.emailAddress1

boolean | null

filter.notNull.emailAddress2

boolean | null

The secondary email address of the guardian, will not be used within the system, but will be displayed for contact information.

filter.notNull.phoneNumber1

boolean | null

The primary phone number of the guardian, will be used for communication with the guardian from the system.

filter.notNull.phoneNumber2

boolean | null

The secondary phone number of the guardian, will not be used within the system, but will be displayed for contact information.

filter.notNull.studentIDs

boolean | null

The IDs of the students the guardian is responsible for.

Example:

{
  "meta": {
    "createdBy": true,
    "updatedAt": true,
    "updatedBy": true
  },
  "external": { "sourceID": true, "source": true },
  "address": {
    "postalAddress": true,
    "postalCode": true,
    "postalCity": true,
    "countryCode": true,
    "municipalityCode": true
  },
  "emailAddress1": true,
  "emailAddress2": true,
  "phoneNumber1": true,
  "phoneNumber2": true,
  "studentIDs": true
}

filter.nestedFilters

any[]

NestedFilters of the Guardian, useful for more complex filters

Example:

{
  "equals": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "meta": {
      "createdAt": "2024-01-15T10:30:00Z",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "updatedAt": "2024-01-15T10:30:00Z",
      "updatedBy": "123e4567-e89b-12d3-a456-426614174000"
    },
    "external": {
      "sourceID": "example",
      "source": "example"
    },
    "identityNumber": "example",
    "identityTemporary": true,
    "firstName": "example",
    "lastName": "example",
    "address": {
      "postalAddress": "example",
      "postalCode": "example",
      "postalCity": "example",
      "countryCode": "example",
      "municipalityCode": "example"
    },
    "emailAddress1": "example",
    "emailAddress2": "example",
    "phoneNumber1": "example",
    "phoneNumber2": "example",
    "studentIDs": "123e4567-e89b-12d3-a456-426614174000"
  },
  "notEquals": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "meta": {
      "createdAt": "2024-01-15T10:30:00Z",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "updatedAt": "2024-01-15T10:30:00Z",
      "updatedBy": "123e4567-e89b-12d3-a456-426614174000"
    },
    "external": {
      "sourceID": "example",
      "source": "example"
    },
    "identityNumber": "example",
    "identityTemporary": true,
    "firstName": "example",
    "lastName": "example",
    "address": {
      "postalAddress": "example",
      "postalCode": "example",
      "postalCity": "example",
      "countryCode": "example",
      "municipalityCode": "example"
    },
    "emailAddress1": "example",
    "emailAddress2": "example",
    "phoneNumber1": "example",
    "phoneNumber2": "example",
    "studentIDs": "123e4567-e89b-12d3-a456-426614174000"
  },
  "greaterThan": {
    "meta": {
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-15T10:30:00Z"
    }
  },
  "smallerThan": {
    "meta": {
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-15T10:30:00Z"
    }
  },
  "greaterOrEqual": {
    "meta": {
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-15T10:30:00Z"
    }
  },
  "smallerOrEqual": {
    "meta": {
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-15T10:30:00Z"
    }
  },
  "contains": {
    "id": ["123e4567-e89b-12d3-a456-426614174000"],
    "meta": {
      "createdBy": ["123e4567-e89b-12d3-a456-426614174000"],
      "updatedBy": ["123e4567-e89b-12d3-a456-426614174000"]
    },
    "external": {
      "sourceID": ["example"],
      "source": ["example"]
    },
    "identityNumber": ["example"],
    "identityTemporary": [true],
    "firstName": ["example"],
    "lastName": ["example"],
    "address": {
      "postalAddress": ["example"],
      "postalCode": ["example"],
      "postalCity": ["example"],
      "countryCode": ["example"],
      "municipalityCode": ["example"]
    },
    "emailAddress1": ["example"],
    "emailAddress2": ["example"],
    "phoneNumber1": ["example"],
    "phoneNumber2": ["example"],
    "studentIDs": ["123e4567-e89b-12d3-a456-426614174000"]
  },
  "notContains": {
    "id": ["123e4567-e89b-12d3-a456-426614174000"],
    "meta": {
      "createdBy": ["123e4567-e89b-12d3-a456-426614174000"],
      "updatedBy": ["123e4567-e89b-12d3-a456-426614174000"]
    },
    "external": {
      "sourceID": ["example"],
      "source": ["example"]
    },
    "identityNumber": ["example"],
    "identityTemporary": [true],
    "firstName": ["example"],
    "lastName": ["example"],
    "address": {
      "postalAddress": ["example"],
      "postalCode": ["example"],
      "postalCity": ["example"],
      "countryCode": ["example"],
      "municipalityCode": ["example"]
    },
    "emailAddress1": ["example"],
    "emailAddress2": ["example"],
    "phoneNumber1": ["example"],
    "phoneNumber2": ["example"],
    "studentIDs": ["123e4567-e89b-12d3-a456-426614174000"]
  },
  "like": {
    "external": {
      "sourceID": "example",
      "source": "example"
    },
    "identityNumber": "example",
    "firstName": "example",
    "lastName": "example",
    "address": {
      "postalAddress": "example",
      "postalCode": "example",
      "postalCity": "example",
      "countryCode": "example",
      "municipalityCode": "example"
    },
    "emailAddress1": "example",
    "emailAddress2": "example",
    "phoneNumber1": "example",
    "phoneNumber2": "example"
  },
  "notLike": {
    "external": {
      "sourceID": "example",
      "source": "example"
    },
    "identityNumber": "example",
    "firstName": "example",
    "lastName": "example",
    "address": {
      "postalAddress": "example",
      "postalCode": "example",
      "postalCity": "example",
      "countryCode": "example",
      "municipalityCode": "example"
    },
    "emailAddress1": "example",
    "emailAddress2": "example",
    "phoneNumber1": "example",
    "phoneNumber2": "example"
  },
  "null": {
    "meta": {
      "createdBy": true,
      "updatedAt": true,
      "updatedBy": true
    },
    "external": { "sourceID": true, "source": true },
    "address": {
      "postalAddress": true,
      "postalCode": true,
      "postalCity": true,
      "countryCode": true,
      "municipalityCode": true
    },
    "emailAddress1": true,
    "emailAddress2": true,
    "phoneNumber1": true,
    "phoneNumber2": true,
    "studentIDs": true
  },
  "notNull": {
    "meta": {
      "createdBy": true,
      "updatedAt": true,
      "updatedBy": true
    },
    "external": { "sourceID": true, "source": true },
    "address": {
      "postalAddress": true,
      "postalCode": true,
      "postalCity": true,
      "countryCode": true,
      "municipalityCode": true
    },
    "emailAddress1": true,
    "emailAddress2": true,
    "phoneNumber1": true,
    "phoneNumber2": true,
    "studentIDs": true
  },
  "orCondition": true
}

Response

Response for Guardian Search operation - returns filtered Guardian results

data

object[]

Array of Guardian objects

Show child attributes

data.id

string<uuid>

required

Unique identifier for the Guardian

data.identityNumber

string

required

The identity number of the guardian, must be unique within the organization.

data.firstName

string

required

The first name of the guardian

data.lastName

string

required

The last name of the guardian

data.meta

object

Metadata information for the Guardian

Show child attributes

data.meta.createdAt

string<date-time>

required

Timestamp when the resource was created

data.meta.createdBy

string<uuid> | null

User who created the resource

data.meta.updatedAt

string<date-time> | null

Timestamp when the resource was last updated

data.meta.updatedBy

string<uuid> | null

User who last updated the resource

Example:

{
  "createdAt": "2024-01-15T10:30:00Z",
  "createdBy": "987fcdeb-51a2-43d1-b567-123456789abc",
  "updatedAt": "2024-01-15T14:45:00Z",
  "updatedBy": "987fcdeb-51a2-43d1-b567-123456789abc"
}

data.external

object

External is a reusable object that can be used to store external information about the guardian from another system, used for third-party integration tracking.

Show child attributes

data.external.sourceID

string | null

The ID of the external source

data.external.source

string | null

The source of the external information

Example:

{
  "sourceID": "12345678",
  "source": "ExternalIntegrationAPI"
}

data.identityTemporary

boolean

default:false

If the identity number is temporary for the guardian

data.address

object

The address of the guardian

Show child attributes

data.address.postalAddress

string | null

The postal address of the address

data.address.postalCode

string | null

The postal code of the address

data.address.postalCity

string | null

The city of the address

data.address.countryCode

string | null

The country code of the address

data.address.municipalityCode

string | null

The municipality code of the address

Example:

{
  "postalAddress": "Dalvägen 14",
  "postalCode": "169 56",
  "postalCity": "Solna",
  "countryCode": "SWE",
  "municipalityCode": "0184"
}

data.emailAddress1

string | null

data.emailAddress2

string | null

The secondary email address of the guardian, will not be used within the system, but will be displayed for contact information.

data.phoneNumber1

string | null

The primary phone number of the guardian, will be used for communication with the guardian from the system.

data.phoneNumber2

string | null

The secondary phone number of the guardian, will not be used within the system, but will be displayed for contact information.

data.studentIDs

string<uuid>[]

The IDs of the students the guardian is responsible for.

pagination

object

Pagination information

Show child attributes

pagination.offset

integer

required

Number of items to skip from the beginning of the result set

pagination.limit

integer

required

Maximum number of items to return in the result set

pagination.total

integer

required

Total number of items available for pagination

Example:

{ "offset": 0, "limit": 1, "total": 100 }

Getting started

Guides

Reference

Authorizations

Query Parameters

Body

Response