---
title: "List property lists"
method: GET
path: "/api/property-lists"
tags: ["Property Lists"]
---

# List property lists

`GET /api/property-lists`

## Request

- Base URL: `https://api.sponsorunited.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.sponsorunited.com/api/property-lists`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/sponsorunited/apis/sponsorunited-api/docs/api/property-lists/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns every administrator-created property list with its owner and property count. Allowed with either the view-administration-property-lists or the review-social-scans permission

## Query parameters

- `with_properties` 0 | 1

## Response `200`

All property lists

- PropertyListsIndex[]
  - `id` integer: A named, reusable set of properties created by an administrator.
  - `name` string
  - `owner_id` integer, nullable
  - `created_at` string, date-time
  - `updated_at` string, date-time
  - `properties_count` integer: One property list as the administration UI shows it: owner, property count and, when the member properties were loaded, their ids and names.
  - `owner` object, nullable
    - `id` integer
    - `email` string
    - `currency` string
    - `created_at` string, date-time
    - `updated_at` string, date-time
    - `deleted_at` string, date-time
    - `last_active_at` string, date-time
    - `is_external` boolean
    - `verified` integer
    - `genuine` integer
    - `hubspot_id` integer
    - `hubspot_synced_on` string, date-time
    - `force_new_password` integer
    - `credentials_sent_at` string, date-time
    - `person_profile` PersonProfile
      - `id` integer
      - `user_id` integer
      - `avatar_id` integer, nullable
      - `person_profile_job_role_id` integer, nullable
      - `market_id` integer, nullable
      - `name` string
      - `job_title` string, nullable
      - `location` string, nullable
      - `school` string, nullable
      - `info` string, nullable
      - `suggested` integer, nullable
      - `previous_suggested` integer, nullable
      - `approved` boolean
      - `created_at` string, date-time
      - `updated_at` string, date-time
      - `deleted_at` string, date-time
  - `properties` object[]: Present only when the member properties were requested
    - `id` integer
    - `name` string

## Other responses

- `403`: The user has neither the admin view permission nor the review permission

---

[API](https://skmtc.dev/sponsorunited/apis/sponsorunited-api.md) - [All operations](https://skmtc.dev/sponsorunited/apis/sponsorunited-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sponsorunited/apis/sponsorunited-api/revisions/cbf1ca5bff8f?raw)