{
  "opencollection": "1.0.0",
  "info": {
    "name": "Luminary Documents Households API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "oauth2",
      "flow": "client_credentials",
      "accessTokenUrl": "https://auth.withluminary.com/oauth2/token",
      "credentials": {
        "clientId": "{{clientId}}",
        "clientSecret": "{{clientSecret}}"
      }
    }
  },
  "items": [
    {
      "info": {
        "name": "Households",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List all households",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{subdomain}.withluminary.com/api/public/v1/households",
            "params": [
              {
                "name": "external_id",
                "value": "",
                "type": "query",
                "description": "Filter by external ID (exact match within the caller's tenant)"
              },
              {
                "name": "after",
                "value": "",
                "type": "query",
                "description": "Cursor for forward pagination. Returns items after this cursor."
              },
              {
                "name": "before",
                "value": "",
                "type": "query",
                "description": "Cursor for backward pagination. Returns items before this cursor."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of items to return"
              }
            ]
          },
          "docs": "Retrieve a paginated list of households using cursor-based pagination"
        },
        {
          "info": {
            "name": "Create a new household",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{subdomain}.withluminary.com/api/public/v1/households",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new household with the provided data"
        },
        {
          "info": {
            "name": "Get a household by ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{subdomain}.withluminary.com/api/public/v1/households/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Household ID"
              }
            ]
          },
          "docs": "Retrieve detailed information about a specific household"
        },
        {
          "info": {
            "name": "Update a household",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{subdomain}.withluminary.com/api/public/v1/households/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Household ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update an existing household with new data"
        },
        {
          "info": {
            "name": "Delete a household",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{subdomain}.withluminary.com/api/public/v1/households/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Household ID"
              }
            ]
          },
          "docs": "Soft delete a household (marks as deleted but preserves data)"
        },
        {
          "info": {
            "name": "List all documents in a household",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{subdomain}.withluminary.com/api/public/v1/households/:id/documents",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Household ID"
              },
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "Filter by document type"
              },
              {
                "name": "after",
                "value": "",
                "type": "query",
                "description": "Cursor for forward pagination. Returns items after this cursor."
              },
              {
                "name": "before",
                "value": "",
                "type": "query",
                "description": "Cursor for backward pagination. Returns items before this cursor."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of items to return"
              }
            ]
          },
          "docs": "Retrieve a paginated list of documents belonging to a specific household"
        },
        {
          "info": {
            "name": "List all entities in a household",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{subdomain}.withluminary.com/api/public/v1/households/:id/entities",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Household ID"
              },
              {
                "name": "kind",
                "value": "",
                "type": "query",
                "description": "Filter by entity kind/type"
              },
              {
                "name": "after",
                "value": "",
                "type": "query",
                "description": "Cursor for forward pagination. Returns items after this cursor."
              },
              {
                "name": "before",
                "value": "",
                "type": "query",
                "description": "Cursor for backward pagination. Returns items before this cursor."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of items to return"
              }
            ]
          },
          "docs": "Retrieve a paginated list of entities belonging to a specific household"
        },
        {
          "info": {
            "name": "List all individuals in a household",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{subdomain}.withluminary.com/api/public/v1/households/:id/individuals",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Household ID"
              },
              {
                "name": "is_primary",
                "value": "",
                "type": "query",
                "description": "Filter by primary client status"
              },
              {
                "name": "after",
                "value": "",
                "type": "query",
                "description": "Cursor for forward pagination. Returns items after this cursor."
              },
              {
                "name": "before",
                "value": "",
                "type": "query",
                "description": "Cursor for backward pagination. Returns items before this cursor."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of items to return"
              }
            ]
          },
          "docs": "Retrieve a paginated list of client profiles/individuals belonging to a specific household"
        }
      ]
    }
  ],
  "bundled": true
}