Guardian
Search Guardians
Search for Guardians with filtering capabilities.
post/guardian/_search
Query parameters
limitinteger
Example:1
The maximum number of Guardians to return (default: 50) when searching Guardians
offsetinteger
The number of Guardians to skip before starting to return results (default: 0) when searching Guardians
Request body
Example request
{
"filter": {
"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,
"nestedFilters": [
{
"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
Example response
{
"data": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"meta": {
"createdAt": "2024-01-15T10:30:00Z",
"createdBy": "987fcdeb-51a2-43d1-b567-123456789abc",
"updatedAt": "2024-01-15T14:45:00Z",
"updatedBy": "987fcdeb-51a2-43d1-b567-123456789abc"
},
"external": {
"sourceID": "12345678",
"source": "ExternalIntegrationAPI"
},
"identityNumber": "20191216-1234",
"identityTemporary": true,
"firstName": "Lise",
"lastName": "Meitner",
"address": {
"postalAddress": "Dalvägen 14",
"postalCode": "169 56",
"postalCity": "Solna",
"countryCode": "SWE",
"municipalityCode": "0184"
},
"emailAddress1": "lise@meitner.se",
"emailAddress2": "lise@gmail.com",
"phoneNumber1": "+46701234567",
"phoneNumber2": "+46701234567",
"studentIDs": [
"123e4567-e89b-12d3-a456-426614174000"
]
}
],
"pagination": {
"limit": 1,
"total": 100
}
}