Organization Tools

Tools for accessing organizational data including buildings, departments, users, groups, and sites.

Buildings & Locations

Get Buildings

List all buildings configured in Jamf Pro.

Parameter	Type	Required	Description
			No parameters required

Example Response

[
  {
    "id": 1,
    "name": "Headquarters",
    "street_address1": "123 Main Street",
    "street_address2": "Suite 100",
    "city": "San Francisco",
    "state_province": "CA",
    "zip_postal_code": "94105",
    "country": "United States"
  },
  {
    "id": 2,
    "name": "East Coast Office",
    "street_address1": "456 Broadway",
    "city": "New York",
    "state_province": "NY",
    "zip_postal_code": "10013",
    "country": "United States"
  }
]

Usage Examples

List all buildings in our organization

Show me all office locations

Get addresses for all buildings

Related Tools

Get Building Details

Detailed building information

Get Building Details

Get Departments

Department assignments

Get Departments

---

Get Building Details

Get detailed information about a specific building.

Parameter	Type	Required	Description
building_id	int | str	Yes	Building ID

Example Response

{
  "id": 1,
  "name": "Headquarters",
  "street_address1": "123 Main Street",
  "street_address2": "Suite 100",
  "city": "San Francisco",
  "state_province": "CA",
  "zip_postal_code": "94105",
  "country": "United States",
  "assigned_computers": 245,
  "assigned_users": 198,
  "assigned_devices": 312
}

Usage Examples

Get details for building ID 1

Show me how many computers are assigned to building 5

Get the full address for building ID 10

Related Tools

Get Buildings

List all buildings

Get Buildings

Search Computers

Find computers by building

Search Computers

---

Departments

Get Departments

List all departments configured in Jamf Pro.

Parameter	Type	Required	Description
			No parameters required

Example Response

[
  {
    "id": 1,
    "name": "Engineering",
    "created_date": "2023-01-15T00:00:00Z",
    "updated_date": "2024-01-10T00:00:00Z"
  },
  {
    "id": 2,
    "name": "Sales",
    "created_date": "2023-01-15T00:00:00Z",
    "updated_date": "2023-12-01T00:00:00Z"
  },
  {
    "id": 3,
    "name": "Human Resources",
    "created_date": "2023-01-15T00:00:00Z",
    "updated_date": "2023-06-15T00:00:00Z"
  }
]

Usage Examples

List all departments in the organization

Show me all departments and when they were created

Get department names and IDs

Related Tools

Get Department Details

Detailed department information

Get Department Details

Get Users

Users by department

Get Users

---

Get Department Details

Get detailed information about a specific department.

Parameter	Type	Required	Description
department_id	int | str	Yes	Department ID

Example Response

{
  "id": 1,
  "name": "Engineering",
  "created_date": "2023-01-15T00:00:00Z",
  "updated_date": "2024-01-10T00:00:00Z",
  "assigned_computers": 87,
  "assigned_users": 92,
  "assigned_devices": 156
}

Usage Examples

Get details for department ID 1

How many computers are assigned to department 5?

Show me user count for Engineering department

Related Tools

Get Departments

List all departments

Get Departments

Search Computers

Find computers by department

Search Computers

---

Users & Groups

Get Users

List all users in Jamf Pro.

Parameter	Type	Required	Description
			No parameters required

Example Response

[
  {
    "id": 1,
    "username": "john.doe",
    "full_name": "John Doe",
    "email": "john.doe@company.com",
    "phone_number": "555-1234",
    "position": "Senior Engineer",
    "enable_custom_photo_url": false,
    "custom_photo_url": "",
    "ldap_server": {
      "id": 1,
      "name": "Corporate AD"
    },
    "extension_attributes": []
  },
  {
    "id": 2,
    "username": "jane.smith",
    "full_name": "Jane Smith",
    "email": "jane.smith@company.com",
    "phone_number": "555-5678",
    "position": "Sales Manager"
  }
]

Usage Examples

List all users in Jamf Pro

Show me all users with their email addresses

Get all users and their positions

Related Tools

Get User Details

Detailed user information

Get User Details

Get User Group Details

User group memberships

Get User Group Details

---

Get User Details

Get detailed information about a specific user.

Parameter	Type	Required	Description
user_id	str	Yes	User ID

Example Response

{
  "id": 1,
  "username": "john.doe",
  "full_name": "John Doe",
  "email": "john.doe@company.com",
  "email_address": "john.doe@company.com",
  "phone_number": "555-1234",
  "position": "Senior Engineer",
  "enable_custom_photo_url": false,
  "custom_photo_url": "",
  "ldap_server": {
    "id": 1,
    "name": "Corporate AD"
  },
  "extension_attributes": [
    {
      "id": 1,
      "name": "Employee ID",
      "type": "String",
      "value": "EMP12345"
    }
  ],
  "sites": [],
  "managed_computers": [
    {
      "id": 123,
      "name": "John's MacBook Pro",
      "serial_number": "ABC123456"
    }
  ],
  "managed_mobile_devices": []
}

Usage Examples

Get details for user ID 1

Show me which computers are assigned to user john.doe

Get employee ID for user 100

Related Tools

Get Users

List all users

Get Users

Get Computer Inventory

Computer assignments

Get Computer Inventory

---

Get User Group Details

Get detailed information about a user group.

Parameter	Type	Required	Description
group_id	int | str	Yes	User group ID

Example Response

{
  "id": 10,
  "name": "Engineering Team",
  "is_smart": true,
  "is_notify_on_change": false,
  "site": {
    "id": -1,
    "name": "None"
  },
  "criteria": [
    {
      "name": "Department",
      "priority": 0,
      "and_or": "and",
      "search_type": "is",
      "value": "Engineering"
    }
  ],
  "users": [
    {
      "id": 1,
      "username": "john.doe",
      "full_name": "John Doe",
      "email": "john.doe@company.com"
    }
  ],
  "user_count": 92
}

Usage Examples

Get details for user group ID 10

Show me all members of the Engineering Team group

What are the criteria for user group 5?

Related Tools

Get Users

List all users

Get Users

Get Smart Groups

Computer groups

Get Smart Groups

---

Sites

Get Sites

List all sites configured in Jamf Pro.

Parameter	Type	Required	Description
			No parameters required

Example Response

[
  {
    "id": -1,
    "name": "None"
  },
  {
    "id": 1,
    "name": "West Coast",
    "created_date": "2023-01-01T00:00:00Z"
  },
  {
    "id": 2,
    "name": "East Coast",
    "created_date": "2023-01-01T00:00:00Z"
  }
]

Usage Examples

List all sites in Jamf Pro

Show me all configured sites

Get site names and IDs

Related Tools

Get Site Details

Detailed site information

Get Site Details

Get Policies

Site-specific policies

Get Policies

---

Get Site Details

Get detailed information about a specific site.

Parameter	Type	Required	Description
site_id	str | int	Yes	Site ID

Example Response

{
  "id": 1,
  "name": "West Coast",
  "created_date": "2023-01-01T00:00:00Z",
  "updated_date": "2024-01-15T00:00:00Z",
  "assigned_objects": {
    "computers": 156,
    "mobile_devices": 203,
    "configuration_profiles": 25,
    "policies": 48,
    "users": 198
  }
}

Usage Examples

Get details for site ID 1

How many computers are assigned to site 2?

Show me all objects assigned to the West Coast site

Related Tools

Get Sites

List all sites

Get Sites

Get Configuration Profiles

Site-specific profiles

Get Configuration Profiles

---

Get Categories

List all categories used for organizing items.

Parameter	Type	Required	Description
			No parameters required

Example Response

[
  {
    "id": 1,
    "name": "Productivity",
    "priority": 9
  },
  {
    "id": 2,
    "name": "Security",
    "priority": 10
  },
  {
    "id": 3,
    "name": "Utilities",
    "priority": 5
  }
]

Usage Examples

List all categories

Show me categories sorted by priority

Get all category names and IDs

Related Tools

Get Category Details

Category usage information

Get Category Details

Get Policies

Policies by category

Get Policies

---

Get Category Details

Get detailed information about a specific category.

Parameter	Type	Required	Description
category_id	str | int	Yes	Category ID

Example Response

{
  "id": 2,
  "name": "Security",
  "priority": 10,
  "usage": {
    "policies": 15,
    "packages": 8,
    "scripts": 12,
    "printers": 0,
    "computer_extension_attributes": 3,
    "mobile_device_extension_attributes": 2
  }
}

Usage Examples

Get details for category ID 2

How many policies use category 5?

Show me usage statistics for the Security category

Related Tools

Get Categories

List all categories

Get Categories

Get Scripts

Scripts by category

Get Scripts

---

Network Segments

Get Network Segments

List all network segments configured in Jamf Pro.

Parameter	Type	Required	Description
			No parameters required

Example Response

[
  {
    "id": 1,
    "name": "Corporate LAN",
    "starting_address": "10.0.0.0",
    "ending_address": "10.0.255.255",
    "distribution_server": "",
    "distribution_point": "",
    "url": "",
    "swu_server": "",
    "building": "Headquarters",
    "department": "",
    "override_buildings": false,
    "override_departments": false
  },
  {
    "id": 2,
    "name": "Guest WiFi",
    "starting_address": "192.168.1.0",
    "ending_address": "192.168.1.255"
  }
]

Usage Examples

List all network segments

Show me IP ranges for all network segments

Get network segments by building

Related Tools

Get Network Segment Details

Detailed segment information

Get Network Segment Details

Get Buildings

Building associations

Get Buildings

---

Get Network Segment Details

Get detailed information about a specific network segment.

Parameter	Type	Required	Description
segment_id	str | int	Yes	Network segment ID

Example Response

{
  "id": 1,
  "name": "Corporate LAN",
  "starting_address": "10.0.0.0",
  "ending_address": "10.0.255.255",
  "distribution_server": "",
  "distribution_point": "Main DP",
  "url": "https://dp.company.com",
  "swu_server": "",
  "building": {
    "id": 1,
    "name": "Headquarters"
  },
  "department": {
    "id": -1,
    "name": "None"
  },
  "override_buildings": false,
  "override_departments": false,
  "assigned_computers": 245
}

Usage Examples

Get details for network segment ID 1

How many computers are on network segment 5?

Show me the IP range for the Corporate LAN segment

Related Tools

Get Network Segments

List all segments

Get Network Segments

Get Building Details

Building information

Get Building Details

---

Best Practices

Building Management

1. Consistent Naming: Use clear, consistent building names

2. Complete Addresses: Include full address for mapping

3. Regular Updates: Keep location info current

4. Assignment Accuracy: Ensure computers assigned correctly

Department Organization

1. Clear Structure: Mirror actual org structure

2. Avoid Duplicates: Prevent similar department names

3. Regular Audits: Review assignments periodically

4. Update Processes: Have process for org changes

User Management

1. Data Completeness: Ensure all users have email/phone

2. LDAP Integration: Leverage directory services

3. Extension Attributes: Use for additional user data

4. Access Reviews: Regular audit of user assignments

Network Segmentation

1. IP Range Accuracy: Ensure ranges don’t overlap

2. Building Association: Link segments to locations

3. Distribution Points: Configure for each segment

4. Documentation: Document segment purposes

See also

• Jamf Pro Buildings API

• Jamf Pro Departments API

• Jamf Pro Users API

• Jamf Pro Sites Documentation