Skip to main content

Query

Description

This query is designed to search and retrieve departments that meet the specified criteria. The required elements and the content of the response may vary depending on the system being integrated with.

API Endpoints for Department Query

Sync REST API Endpoint to call the API: https://{base_url}/api/v1/department/query.

Async REST API Endpoint to call the API: https://{base_url}/api/v1/endpoint.

Data Model JSON for Department Query​

Query - Sample Payload
{
    "Meta": {
        "DataModel": "Department",
        "EventType": "Query",
        "Test": true,
        "Source": {
        "ID": "b2158008-c853-4d10-b313-6c71ec82e176",
        "Name": "CustomerID"
       }
 },
    "Identifier": {
        "ID": "675844",
        "IDType": "departmentid"
    },
    "Name": null,
    "Type": null,
    "RadiusSearch": {
        "ZipCode": null,
        "State": null,
        "City": null,
        "StreetAddress": "kansas"
    },
    "Limit": null
}