{
  "info": {
    "_postman_id": "46ddda3a-f288-4b38-b1a9-61ddd83bf89c",
    "name": "Hum API",
    "description": "Requests for address availability, session management, FCC provider lookup, and partner analytics.",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
  },
  "auth": {
    "type": "bearer",
    "bearer": [
      {
        "key": "token",
        "value": "{{api_key}}",
        "type": "string"
      }
    ]
  },
  "variable": [
    {
      "key": "base_url",
      "value": "https://api-sandbox.letshum.com",
      "type": "string"
    },
    {
      "key": "session_token",
      "value": "",
      "type": "string"
    },
    {
      "key": "analytics_session_id",
      "value": "",
      "type": "string"
    }
  ],
  "item": [
    {
      "name": "Sessions",
      "description": "Create, retrieve, use, and close address lookup sessions.",
      "item": [
        {
          "name": "Create Session",
          "event": [
            {
              "listen": "test",
              "script": {
                "type": "text/javascript",
                "packages": {},
                "exec": [
                  "const json = pm.response.json(); if (json.meta && json.meta.session_token) pm.collectionVariables.set('session_token', json.meta.session_token);"
                ]
              }
            }
          ],
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json",
                "type": "text"
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"street1\": \"29090 Tiffany Drive E\",\n  \"zip\": \"48034\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "url": {
              "raw": "{{base_url}}/sessions",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "sessions"
              ]
            },
            "description": "Creates an address lookup session and returns provider availability immediately.\nAlternate request with a unit: `{\"street1\": \"29090 Tiffany Drive E\", \"street2\": \"Apt 4B\", \"zip\": \"48034\"}`."
          },
          "response": []
        },
        {
          "name": "Get Session Status",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/sessions/{{session_token}}",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "sessions",
                "{{session_token}}"
              ]
            },
            "description": "Retrieves an open session and its normalized address metadata. Provider results are returned when the session is created."
          },
          "response": []
        },
        {
          "name": "Get Internet Services",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/sessions/{{session_token}}/services/internet",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "sessions",
                "{{session_token}}",
                "services",
                "internet"
              ]
            },
            "description": "Returns internet providers, plans, pricing, and technologies for the session's service address."
          },
          "response": []
        },
        {
          "name": "Close Session",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{base_url}}/sessions/{{session_token}}",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "sessions",
                "{{session_token}}"
              ]
            },
            "description": "Closes an active session. Closed sessions cannot be reopened."
          },
          "response": []
        }
      ]
    },
    {
      "name": "Analytics",
      "description": "Retrieve partner-scoped session, order, and commission reporting data.",
      "item": [
        {
          "name": "List Analytics Sessions",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/analytics/sessions?page=1",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "analytics",
                "sessions"
              ],
              "query": [
                {
                  "key": "page",
                  "value": "1"
                },
                {
                  "key": "updated_since",
                  "value": "2026-03-10T00:00:00Z",
                  "disabled": true
                },
                {
                  "key": "start_date",
                  "value": "2026-01-01T00:00:00Z",
                  "disabled": true
                },
                {
                  "key": "end_date",
                  "value": "2026-03-31T23:59:59Z",
                  "disabled": true
                },
                {
                  "key": "with_clicks",
                  "value": "true",
                  "disabled": true
                }
              ]
            },
            "description": "Lists sessions with address, cart progression, order, and commission data. Results are scoped to the authenticated partner and paginated at 50 sessions per page."
          },
          "response": []
        },
        {
          "name": "Get Analytics Session Detail",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/analytics/sessions/{{analytics_session_id}}",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "analytics",
                "sessions",
                "{{analytics_session_id}}"
              ]
            },
            "description": "Returns one partner-owned session with its order, commission, and full cart progression timeline."
          },
          "response": []
        }
      ]
    },
    {
      "name": "Utilities",
      "description": "Validate credentials and retrieve FCC provider identifiers.",
      "item": [
        {
          "name": "Health Check",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/ping",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "ping"
              ]
            },
            "description": "Verifies API availability and confirms that the selected environment accepts the API key."
          },
          "response": []
        },
        {
          "name": "Get FCC Service Providers",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/service_providers",
              "host": [
                "{{base_url}}"
              ],
              "path": [
                "service_providers"
              ]
            },
            "description": "Returns FCC service providers and supplemental brands used for Hum availability lookups."
          },
          "response": []
        }
      ]
    }
  ]
}