--- title: "Search Guardians" method: POST path: "/guardian/_search" tags: ["Guardian"] --- # Search Guardians `POST /guardian/_search` Search for `Guardians` with filtering capabilities. ## Query parameters - `limit` integer - `offset` integer ## Request body - object - `filter` GuardianFilter, required — Filter object for Guardian - `equals` GuardianFilterEquals — Equality/Inequality filter fields for Guardian - `id` string, uuid, nullable — Unique identifier for the Guardian - `meta` MetaFilterEquals — Equality/Inequality filter fields for Meta - `createdAt` string, date-time, nullable — Timestamp when the resource was created - `createdBy` string, uuid, nullable — User who created the resource - `updatedAt` string, date-time, nullable — Timestamp when the resource was last updated - `updatedBy` string, uuid, nullable — User who last updated the resource - `external` ExternalFilterEquals — Equality/Inequality filter fields for External - `sourceID` string, nullable — The ID of the external source - `source` string, nullable — The source of the external information - `identityNumber` string, nullable — The identity number of the guardian in the format YYYYMMDD-NNNN, must be unique within the organization. - `identityTemporary` boolean, nullable — If the identity number is temporary for the guardian - `firstName` string, nullable — The first name of the guardian - `lastName` string, nullable — The last name of the guardian - `address` AddressFilterEquals — Equality/Inequality filter fields for Address - `postalAddress` string, nullable — The postal address of the address - `postalCode` string, nullable — The postal code (also known as ZIP or postcode) of the address, used together with the city to identify the delivery area. - `postalCity` string, nullable — The city of the address - `countryCode` string, nullable — The ISO 3166-1 alpha-3 country code of the address (e.g. "SWE" for Sweden). - `municipalityCode` string, nullable — The Swedish municipality (kommun) code for the address — a four-digit code as defined by Statistics Sweden (SCB), e.g. "0184" for Solna. Identifies the administrative municipality the address belongs to. - `emailAddress1` string, nullable — 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. - `emailAddress2` string, nullable — The secondary email address of the guardian, will not be used within the system, but will be displayed for contact information. - `phoneNumber1` string, nullable — The primary phone number of the guardian, will be used for communication with the guardian from the system. - `phoneNumber2` string, nullable — The secondary phone number of the guardian, will not be used within the system, but will be displayed for contact information. - `studentIDs` string, uuid, nullable — The IDs of the students the guardian is responsible for. - `notEquals` GuardianFilterEquals — Equality/Inequality filter fields for Guardian - `id` string, uuid, nullable — Unique identifier for the Guardian - `meta` MetaFilterEquals — Equality/Inequality filter fields for Meta - `createdAt` string, date-time, nullable — Timestamp when the resource was created - `createdBy` string, uuid, nullable — User who created the resource - `updatedAt` string, date-time, nullable — Timestamp when the resource was last updated - `updatedBy` string, uuid, nullable — User who last updated the resource - `external` ExternalFilterEquals — Equality/Inequality filter fields for External - `sourceID` string, nullable — The ID of the external source - `source` string, nullable — The source of the external information - `identityNumber` string, nullable — The identity number of the guardian in the format YYYYMMDD-NNNN, must be unique within the organization. - `identityTemporary` boolean, nullable — If the identity number is temporary for the guardian - `firstName` string, nullable — The first name of the guardian - `lastName` string, nullable — The last name of the guardian - `address` AddressFilterEquals — Equality/Inequality filter fields for Address - `postalAddress` string, nullable — The postal address of the address - `postalCode` string, nullable — The postal code (also known as ZIP or postcode) of the address, used together with the city to identify the delivery area. - `postalCity` string, nullable — The city of the address - `countryCode` string, nullable — The ISO 3166-1 alpha-3 country code of the address (e.g. "SWE" for Sweden). - `municipalityCode` string, nullable — The Swedish municipality (kommun) code for the address — a four-digit code as defined by Statistics Sweden (SCB), e.g. "0184" for Solna. Identifies the administrative municipality the address belongs to. - `emailAddress1` string, nullable — 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. - `emailAddress2` string, nullable — The secondary email address of the guardian, will not be used within the system, but will be displayed for contact information. - `phoneNumber1` string, nullable — The primary phone number of the guardian, will be used for communication with the guardian from the system. - `phoneNumber2` string, nullable — The secondary phone number of the guardian, will not be used within the system, but will be displayed for contact information. - `studentIDs` string, uuid, nullable — The IDs of the students the guardian is responsible for. - `greaterThan` GuardianFilterRange — Range filter fields for Guardian - `meta` MetaFilterRange — Range filter fields for Meta - `createdAt` string, date-time, nullable — Timestamp when the resource was created - `updatedAt` string, date-time, nullable — Timestamp when the resource was last updated - `external` ExternalFilterRange — Range filter fields for External - `address` AddressFilterRange — Range filter fields for Address - `smallerThan` GuardianFilterRange — Range filter fields for Guardian - `meta` MetaFilterRange — Range filter fields for Meta - `createdAt` string, date-time, nullable — Timestamp when the resource was created - `updatedAt` string, date-time, nullable — Timestamp when the resource was last updated - `external` ExternalFilterRange — Range filter fields for External - `address` AddressFilterRange — Range filter fields for Address - `greaterOrEqual` GuardianFilterRange — Range filter fields for Guardian - `meta` MetaFilterRange — Range filter fields for Meta - `createdAt` string, date-time, nullable — Timestamp when the resource was created - `updatedAt` string, date-time, nullable — Timestamp when the resource was last updated - `external` ExternalFilterRange — Range filter fields for External - `address` AddressFilterRange — Range filter fields for Address - `smallerOrEqual` GuardianFilterRange — Range filter fields for Guardian - `meta` MetaFilterRange — Range filter fields for Meta - `createdAt` string, date-time, nullable — Timestamp when the resource was created - `updatedAt` string, date-time, nullable — Timestamp when the resource was last updated - `external` ExternalFilterRange — Range filter fields for External - `address` AddressFilterRange — Range filter fields for Address - `contains` GuardianFilterContains — Contains filter fields for Guardian - `id` string[] — Unique identifier for the Guardian - `meta` MetaFilterContains — Contains filter fields for Meta - `createdBy` string[] — User who created the resource - `updatedBy` string[] — User who last updated the resource - `external` ExternalFilterContains — Contains filter fields for External - `sourceID` string[] — The ID of the external source - `source` string[] — The source of the external information - `identityNumber` string[] — The identity number of the guardian in the format YYYYMMDD-NNNN, must be unique within the organization. - `identityTemporary` boolean[] — If the identity number is temporary for the guardian - `firstName` string[] — The first name of the guardian - `lastName` string[] — The last name of the guardian - `address` AddressFilterContains — Contains filter fields for Address - `postalAddress` string[] — The postal address of the address - `postalCode` string[] — The postal code (also known as ZIP or postcode) of the address, used together with the city to identify the delivery area. - `postalCity` string[] — The city of the address - `countryCode` string[] — The ISO 3166-1 alpha-3 country code of the address (e.g. "SWE" for Sweden). - `municipalityCode` string[] — The Swedish municipality (kommun) code for the address — a four-digit code as defined by Statistics Sweden (SCB), e.g. "0184" for Solna. Identifies the administrative municipality the address belongs to. - `emailAddress1` string[] — 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. - `emailAddress2` string[] — The secondary email address of the guardian, will not be used within the system, but will be displayed for contact information. - `phoneNumber1` string[] — The primary phone number of the guardian, will be used for communication with the guardian from the system. - `phoneNumber2` string[] — The secondary phone number of the guardian, will not be used within the system, but will be displayed for contact information. - `studentIDs` string[] — The IDs of the students the guardian is responsible for. - `notContains` GuardianFilterContains — Contains filter fields for Guardian - `id` string[] — Unique identifier for the Guardian - `meta` MetaFilterContains — Contains filter fields for Meta - `createdBy` string[] — User who created the resource - `updatedBy` string[] — User who last updated the resource - `external` ExternalFilterContains — Contains filter fields for External - `sourceID` string[] — The ID of the external source - `source` string[] — The source of the external information - `identityNumber` string[] — The identity number of the guardian in the format YYYYMMDD-NNNN, must be unique within the organization. - `identityTemporary` boolean[] — If the identity number is temporary for the guardian - `firstName` string[] — The first name of the guardian - `lastName` string[] — The last name of the guardian - `address` AddressFilterContains — Contains filter fields for Address - `postalAddress` string[] — The postal address of the address - `postalCode` string[] — The postal code (also known as ZIP or postcode) of the address, used together with the city to identify the delivery area. - `postalCity` string[] — The city of the address - `countryCode` string[] — The ISO 3166-1 alpha-3 country code of the address (e.g. "SWE" for Sweden). - `municipalityCode` string[] — The Swedish municipality (kommun) code for the address — a four-digit code as defined by Statistics Sweden (SCB), e.g. "0184" for Solna. Identifies the administrative municipality the address belongs to. - `emailAddress1` string[] — 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. - `emailAddress2` string[] — The secondary email address of the guardian, will not be used within the system, but will be displayed for contact information. - `phoneNumber1` string[] — The primary phone number of the guardian, will be used for communication with the guardian from the system. - `phoneNumber2` string[] — The secondary phone number of the guardian, will not be used within the system, but will be displayed for contact information. - `studentIDs` string[] — The IDs of the students the guardian is responsible for. - `like` GuardianFilterLike — LIKE filter fields for Guardian - `meta` MetaFilterLike — LIKE filter fields for Meta - `external` ExternalFilterLike — LIKE filter fields for External - `sourceID` string, nullable — The ID of the external source - `source` string, nullable — The source of the external information - `identityNumber` string, nullable — The identity number of the guardian in the format YYYYMMDD-NNNN, must be unique within the organization. - `firstName` string, nullable — The first name of the guardian - `lastName` string, nullable — The last name of the guardian - `address` AddressFilterLike — LIKE filter fields for Address - `postalAddress` string, nullable — The postal address of the address - `postalCode` string, nullable — The postal code (also known as ZIP or postcode) of the address, used together with the city to identify the delivery area. - `postalCity` string, nullable — The city of the address - `countryCode` string, nullable — The ISO 3166-1 alpha-3 country code of the address (e.g. "SWE" for Sweden). - `municipalityCode` string, nullable — The Swedish municipality (kommun) code for the address — a four-digit code as defined by Statistics Sweden (SCB), e.g. "0184" for Solna. Identifies the administrative municipality the address belongs to. - `emailAddress1` string, nullable — 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. - `emailAddress2` string, nullable — The secondary email address of the guardian, will not be used within the system, but will be displayed for contact information. - `phoneNumber1` string, nullable — The primary phone number of the guardian, will be used for communication with the guardian from the system. - `phoneNumber2` string, nullable — The secondary phone number of the guardian, will not be used within the system, but will be displayed for contact information. - `notLike` GuardianFilterLike — LIKE filter fields for Guardian - `meta` MetaFilterLike — LIKE filter fields for Meta - `external` ExternalFilterLike — LIKE filter fields for External - `sourceID` string, nullable — The ID of the external source - `source` string, nullable — The source of the external information - `identityNumber` string, nullable — The identity number of the guardian in the format YYYYMMDD-NNNN, must be unique within the organization. - `firstName` string, nullable — The first name of the guardian - `lastName` string, nullable — The last name of the guardian - `address` AddressFilterLike — LIKE filter fields for Address - `postalAddress` string, nullable — The postal address of the address - `postalCode` string, nullable — The postal code (also known as ZIP or postcode) of the address, used together with the city to identify the delivery area. - `postalCity` string, nullable — The city of the address - `countryCode` string, nullable — The ISO 3166-1 alpha-3 country code of the address (e.g. "SWE" for Sweden). - `municipalityCode` string, nullable — The Swedish municipality (kommun) code for the address — a four-digit code as defined by Statistics Sweden (SCB), e.g. "0184" for Solna. Identifies the administrative municipality the address belongs to. - `emailAddress1` string, nullable — 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. - `emailAddress2` string, nullable — The secondary email address of the guardian, will not be used within the system, but will be displayed for contact information. - `phoneNumber1` string, nullable — The primary phone number of the guardian, will be used for communication with the guardian from the system. - `phoneNumber2` string, nullable — The secondary phone number of the guardian, will not be used within the system, but will be displayed for contact information. - `null` GuardianFilterNull — Null filter fields for Guardian - `meta` MetaFilterNull — Null filter fields for Meta - `createdBy` boolean, nullable — User who created the resource - `updatedAt` boolean, nullable — Timestamp when the resource was last updated - `updatedBy` boolean, nullable — User who last updated the resource - `external` ExternalFilterNull — Null filter fields for External - `sourceID` boolean, nullable — The ID of the external source - `source` boolean, nullable — The source of the external information - `address` AddressFilterNull — Null filter fields for Address - `postalAddress` boolean, nullable — The postal address of the address - `postalCode` boolean, nullable — The postal code (also known as ZIP or postcode) of the address, used together with the city to identify the delivery area. - `postalCity` boolean, nullable — The city of the address - `countryCode` boolean, nullable — The ISO 3166-1 alpha-3 country code of the address (e.g. "SWE" for Sweden). - `municipalityCode` boolean, nullable — The Swedish municipality (kommun) code for the address — a four-digit code as defined by Statistics Sweden (SCB), e.g. "0184" for Solna. Identifies the administrative municipality the address belongs to. - `emailAddress1` boolean, nullable — 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. - `emailAddress2` boolean, nullable — The secondary email address of the guardian, will not be used within the system, but will be displayed for contact information. - `phoneNumber1` boolean, nullable — The primary phone number of the guardian, will be used for communication with the guardian from the system. - `phoneNumber2` boolean, nullable — The secondary phone number of the guardian, will not be used within the system, but will be displayed for contact information. - `studentIDs` boolean, nullable — The IDs of the students the guardian is responsible for. - `notNull` GuardianFilterNull — Null filter fields for Guardian - `meta` MetaFilterNull — Null filter fields for Meta - `createdBy` boolean, nullable — User who created the resource - `updatedAt` boolean, nullable — Timestamp when the resource was last updated - `updatedBy` boolean, nullable — User who last updated the resource - `external` ExternalFilterNull — Null filter fields for External - `sourceID` boolean, nullable — The ID of the external source - `source` boolean, nullable — The source of the external information - `address` AddressFilterNull — Null filter fields for Address - `postalAddress` boolean, nullable — The postal address of the address - `postalCode` boolean, nullable — The postal code (also known as ZIP or postcode) of the address, used together with the city to identify the delivery area. - `postalCity` boolean, nullable — The city of the address - `countryCode` boolean, nullable — The ISO 3166-1 alpha-3 country code of the address (e.g. "SWE" for Sweden). - `municipalityCode` boolean, nullable — The Swedish municipality (kommun) code for the address — a four-digit code as defined by Statistics Sweden (SCB), e.g. "0184" for Solna. Identifies the administrative municipality the address belongs to. - `emailAddress1` boolean, nullable — 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. - `emailAddress2` boolean, nullable — The secondary email address of the guardian, will not be used within the system, but will be displayed for contact information. - `phoneNumber1` boolean, nullable — The primary phone number of the guardian, will be used for communication with the guardian from the system. - `phoneNumber2` boolean, nullable — The secondary phone number of the guardian, will not be used within the system, but will be displayed for contact information. - `studentIDs` boolean, nullable — The IDs of the students the guardian is responsible for. - `orCondition` boolean, required — OrCondition decides if this filter is within an OR-condition or AND-condition - `nestedFilters` GuardianFilter[] — NestedFilters of the Guardian, useful for more complex filters ## Response `200` Response for Guardian Search operation - returns filtered Guardian results - object - `data` Guardian[] — Array of Guardian objects - `id` string, uuid, required — Unique identifier for the Guardian - `meta` Meta — Meta contains information about the creation and modification of a resource for auditing purposes - `createdAt` string, date-time, required — Timestamp when the resource was created - `createdBy` string, uuid, nullable — User who created the resource - `updatedAt` string, date-time, nullable — Timestamp when the resource was last updated - `updatedBy` string, uuid, nullable — User who last updated the resource - `external` External — External is a reusable object that can be used to store external information from another system, used for third-party integration tracking. - `sourceID` string, nullable — The ID of the external source - `source` string, nullable — The source of the external information - `identityNumber` string, required — The identity number of the guardian in the format YYYYMMDD-NNNN, must be unique within the organization. - `identityTemporary` boolean — If the identity number is temporary for the guardian - `firstName` string, required — The first name of the guardian - `lastName` string, required — The last name of the guardian - `address` Address — Address is a reusable object that can be used to store address information. - `postalAddress` string, nullable — The postal address of the address - `postalCode` string, nullable — The postal code (also known as ZIP or postcode) of the address, used together with the city to identify the delivery area. - `postalCity` string, nullable — The city of the address - `countryCode` string, nullable — The ISO 3166-1 alpha-3 country code of the address (e.g. "SWE" for Sweden). - `municipalityCode` string, nullable — The Swedish municipality (kommun) code for the address — a four-digit code as defined by Statistics Sweden (SCB), e.g. "0184" for Solna. Identifies the administrative municipality the address belongs to. - `emailAddress1` string, nullable — 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. - `emailAddress2` string, nullable — The secondary email address of the guardian, will not be used within the system, but will be displayed for contact information. - `phoneNumber1` string, nullable — The primary phone number of the guardian, will be used for communication with the guardian from the system. - `phoneNumber2` string, nullable — The secondary phone number of the guardian, will not be used within the system, but will be displayed for contact information. - `studentIDs` string[] — The IDs of the students the guardian is responsible for. - `pagination` Pagination — Pagination parameters for controlling result sets in list operations - `offset` integer, required — Number of items to skip from the beginning of the result set - `limit` integer, required — Maximum number of items to return in the result set - `total` integer, required — Total number of items available for pagination ## Other responses - `400` — Bad Request - The request was malformed or contained invalid parameters - `401` — Unauthorized - The request is missing valid authentication credentials - `403` — Forbidden - Request is authenticated, but the user is not allowed to perform the operation - `404` — Not Found - The requested resource does not exist - `409` — Conflict - The request could not be completed due to a conflict - `422` — Validation error for Guardian Search operation - request data failed validation - `429` — Too Many Requests - When the rate limit has been exceeded - `500` — Internal Server Error - An unexpected server error occurred --- [API](https://skmtc.net/meitner/apis/directory-api.md) · [All operations](https://skmtc.net/meitner/apis/directory-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/meitner/directory-api/versions/014348a7bc35/schema)