# List voluntary exclusions

Endpoint: GET /api/v1/voluntary_exclusions
Version: 1.0
Security: authorization

## Query parameters:

  - `pagination` (object)

  - `filter` (object)

## Response 200 fields (application/json):

  - `data` (array)
    Collection of voluntary exclusions
    Example: [{"id":"f411a80b-dddb-4edc-b968-68a9ba41e987","propertySelections":[{"durationMonths":12,"id":"59ae7552-44ed-4009-92c3-9ff93c11f5a6","property":{"id":"d2a24d1d-880c-49e3-b967-19aed134896e","name":"Property 1"},"propertyStatus":"excluded"}],"startDate":"2025-01-01","status":"excluded","submittedAt":"2025-01-01T12:00:00Z","user":{"address":{"city":"Anytown","line1":"123 Main St","line2":null,"postalCode":"12345","state":"CA"},"dob":"1990-01-01","email":"john.doe@example.com","firstName":"John","id":"e418c0c8-c418-49cd-8e0a-35b6e05be8f0","lastName":"Doe","middleName":null,"name":"John Doe","phoneNumber":"+1234567890","preferredName":"John"},"userPhotos":[{"contentType":"image/jpeg","id":"72e35b2f-cb02-40a9-a09e-7f315c0ef905","kind":"face_and_id","path":"https://example.com/photo.jpg"}]}]

  - `data.id` (string, required)
    Unique identifier for the CFS exclusion
    Example: "f411a80b-dddb-4edc-b968-68a9ba41e987"

  - `data.propertySelections` (array)
    Example: [{"durationMonths":12,"id":"59ae7552-44ed-4009-92c3-9ff93c11f5a6","property":{"id":"d2a24d1d-880c-49e3-b967-19aed134896e","name":"Property 1"},"propertyStatus":"excluded"}]

  - `data.propertySelections.id` (string, required)
    Unique identifier for the property selection

  - `data.propertySelections.propertyStatus` (string)
    Current exclusion status for the property

  - `data.startDate` (string)
    Date of the start of the exclusion
    Example: "2025-01-01"

  - `data.status` (string, required)
    Current exclusion status
    Example: "excluded"

  - `data.submittedAt` (string)
    Timestamp of when the voluntary exclusion was submitted
    Example: "2025-01-01T12:00:00Z"

  - `data.user` (object)
    Example: {"address":{"city":"Anytown","line1":"123 Main St","line2":null,"postalCode":"12345","state":"CA"},"dob":"1990-01-01","email":"john.doe@example.com","firstName":"John","id":"e418c0c8-c418-49cd-8e0a-35b6e05be8f0","lastName":"Doe","middleName":null,"name":"John Doe","phoneNumber":"+1234567890","preferredName":"John"}

  - `data.user.address` (object)
    Example: {"city":"Anytown","line1":"123 Main St","line2":null,"postalCode":"12345","state":"CA"}

  - `data.user.address.city` (string)
    City of the user's address
    Example: "Anytown"

  - `data.user.address.line1` (string)
    First line of the user's address
    Example: "123 Main St"

  - `data.user.address.line2` (string)
    Second line of the user's address

  - `data.user.address.postalCode` (string)
    Postal code of the user's address
    Example: "12345"

  - `data.user.address.state` (string)
    State of the user's address
    Example: "CA"

  - `data.user.dob` (string)
    Date of birth of the user
    Example: "1990-01-01"

  - `data.user.email` (string)
    Email address of the user
    Example: "john.doe@example.com"

  - `data.user.firstName` (string)
    First name of the user
    Example: "John"

  - `data.user.id` (string, required)
    Unique identifier for the user
    Example: "e418c0c8-c418-49cd-8e0a-35b6e05be8f0"

  - `data.user.lastName` (string)
    Last name of the user
    Example: "Doe"

  - `data.user.middleName` (string)
    Middle name of the user

  - `data.user.name` (string)
    Full name of the user
    Example: "John Doe"

  - `data.user.phoneNumber` (string)
    Phone number of the user
    Example: "+1234567890"

  - `data.user.preferredName` (string)
    Preferred name of the user
    Example: "John"

  - `data.userPhotos` (array)
    Example: [{"contentType":"image/jpeg","id":"72e35b2f-cb02-40a9-a09e-7f315c0ef905","kind":"face_and_id","path":"https://example.com/photo.jpg"}]

  - `data.userPhotos.id` (string, required)
    Unique identifier for the user photo

  - `meta` (object)

  - `meta.after` (string)
    Cursor pointing to the next page

  - `meta.before` (string)
    Cursor pointing to the previous page

  - `meta.limit` (integer)
    Number of items per page

  - `meta.totalCount` (integer)
    Total number of items