{
  "opencollection": "1.0.0",
  "info": {
    "name": "Plansource Admin Resources API",
    "version": "2.0.0"
  },
  "request": {
    "auth": {
      "type": "oauth2",
      "flow": "client_credentials",
      "accessTokenUrl": "https://api.plansource.com/oauth/v2/token",
      "credentials": {
        "clientId": "{{clientId}}",
        "clientSecret": "{{clientSecret}}"
      }
    }
  },
  "items": [
    {
      "info": {
        "name": "Resources",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "POST /subscriber",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.plansource.com/admin/v2/subscriber",
            "params": [
              {
                "name": "is_custom_id",
                "value": "",
                "type": "query",
                "description": "Set to true if the {id} in the path is customer generated."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a subscriber resource."
        },
        {
          "info": {
            "name": "GET /subscriber/meta",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.plansource.com/admin/v2/subscriber/meta"
          },
          "docs": "Retrieve meta data for subscriber."
        },
        {
          "info": {
            "name": "GET /subscriber/{id}",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.plansource.com/admin/v2/subscriber/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the subscriber."
              },
              {
                "name": "is_custom_id",
                "value": "",
                "type": "query",
                "description": "Set to true if the {id} in the path is customer generated."
              }
            ]
          },
          "docs": "Retrieve data for a subscriber."
        },
        {
          "info": {
            "name": "PUT /subscriber/{id}",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.plansource.com/admin/v2/subscriber/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the subscriber."
              },
              {
                "name": "is_custom_id",
                "value": "",
                "type": "query",
                "description": "Set to true if the {id} in the path is customer generated."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update data for a subscriber."
        },
        {
          "info": {
            "name": "PUT /subscriber/{id}/terminate",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.plansource.com/admin/v2/subscriber/:id/terminate",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the subscriber to terminate."
              },
              {
                "name": "is_custom_id",
                "value": "",
                "type": "query",
                "description": "Set to true if the {id} in the path is customer generated."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Terminate a subscriber."
        },
        {
          "info": {
            "name": "PUT /subscriber/{id}/rehire",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.plansource.com/admin/v2/subscriber/:id/rehire",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the subscriber to rehire."
              },
              {
                "name": "is_custom_id",
                "value": "",
                "type": "query",
                "description": "Set to true if the {id} in the path is customer generated."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Rehire a subscriber."
        },
        {
          "info": {
            "name": "POST /subscriber/{subscriber_id}/dependent",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.plansource.com/admin/v2/subscriber/:subscriber_id/dependent",
            "params": [
              {
                "name": "subscriber_id",
                "value": "",
                "type": "path",
                "description": "The ID of the subscriber."
              },
              {
                "name": "is_custom_id",
                "value": "",
                "type": "query",
                "description": "Set to true if the {subscriber_id} in the path is customer generated."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a dependent resource."
        },
        {
          "info": {
            "name": "GET /dependent/meta",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.plansource.com/admin/v2/dependent/meta"
          },
          "docs": "Retrieve meta data for dependent."
        },
        {
          "info": {
            "name": "GET /subscriber/{subscriber_id}/dependent/{id}",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.plansource.com/admin/v2/subscriber/:subscriber_id/dependent/:id",
            "params": [
              {
                "name": "subscriber_id",
                "value": "",
                "type": "path",
                "description": "The ID of the subscriber."
              },
              {
                "name": "is_custom_id",
                "value": "",
                "type": "query",
                "description": "Set to true if the {subscriber_id} in the path is customer generated."
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the dependent to fetch."
              }
            ]
          },
          "docs": "Retrieve data for a dependent."
        },
        {
          "info": {
            "name": "PUT /subscriber/{subscriber_id}/dependent/{id}",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.plansource.com/admin/v2/subscriber/:subscriber_id/dependent/:id",
            "params": [
              {
                "name": "subscriber_id",
                "value": "",
                "type": "path",
                "description": "The ID of the subscriber."
              },
              {
                "name": "is_custom_id",
                "value": "",
                "type": "query",
                "description": "Set to true if the {subscriber_id} in the path is customer generated."
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the dependent to update."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update data for a dependent."
        },
        {
          "info": {
            "name": "PUT /subscriber/{subscriber_id}/dependent/{id}/deactivate",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.plansource.com/admin/v2/subscriber/:subscriber_id/dependent/:id/deactivate",
            "params": [
              {
                "name": "subscriber_id",
                "value": "",
                "type": "path",
                "description": "The ID of the subscriber."
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the dependent to deactivate."
              },
              {
                "name": "is_custom_id",
                "value": "",
                "type": "query",
                "description": "Set to true if the {subscriber_id} in the path is customer generated."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Deactivate a dependent."
        },
        {
          "info": {
            "name": "PUT /subscriber/{subscriber_id}/dependent/{id}/reactivate",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.plansource.com/admin/v2/subscriber/:subscriber_id/dependent/:id/reactivate",
            "params": [
              {
                "name": "subscriber_id",
                "value": "",
                "type": "path",
                "description": "The ID of the subscriber."
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the dependent to reactivate."
              },
              {
                "name": "is_custom_id",
                "value": "",
                "type": "query",
                "description": "Set to true if the {subscriber_id} in the path is customer generated."
              }
            ]
          },
          "docs": "Reactivate a dependent."
        },
        {
          "info": {
            "name": "GET /beneficiaries/meta",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.plansource.com/admin/v2/beneficiaries/meta"
          },
          "docs": "Retrieve meta data for beneficiaries."
        },
        {
          "info": {
            "name": "GET /beneficiaries",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.plansource.com/admin/v2/beneficiaries",
            "params": [
              {
                "name": "include_test",
                "value": "",
                "type": "query",
                "description": "Include test employees."
              }
            ]
          },
          "docs": "Retrieve all beneficiaries for an organization."
        },
        {
          "info": {
            "name": "GET /subscriber/{subscriber_id}/beneficiaries",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.plansource.com/admin/v2/subscriber/:subscriber_id/beneficiaries",
            "params": [
              {
                "name": "subscriber_id",
                "value": "",
                "type": "path",
                "description": "The ID of the subscriber."
              },
              {
                "name": "is_custom_id",
                "value": "",
                "type": "query",
                "description": "Set to true if the {subscriber_id} in the path is customer generated."
              }
            ]
          },
          "docs": "Retrieve all beneficiaries for a subscriber."
        },
        {
          "info": {
            "name": "GET /coverage/{coverage_id}/beneficiaries",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.plansource.com/admin/v2/coverage/:coverage_id/beneficiaries",
            "params": [
              {
                "name": "coverage_id",
                "value": "",
                "type": "path",
                "description": "The ID of the coverage."
              }
            ]
          },
          "docs": "Retrieve all beneficiaries for a coverage."
        },
        {
          "info": {
            "name": "POST /coverage/{coverage_id}/beneficiaries",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.plansource.com/admin/v2/coverage/:coverage_id/beneficiaries",
            "params": [
              {
                "name": "coverage_id",
                "value": "",
                "type": "path",
                "description": "The ID of the coverage."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create beneficiary resources for a coverage."
        },
        {
          "info": {
            "name": "PUT /coverage/{coverage_id}/beneficiaries",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.plansource.com/admin/v2/coverage/:coverage_id/beneficiaries",
            "params": [
              {
                "name": "coverage_id",
                "value": "",
                "type": "path",
                "description": "The ID of the coverage."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update data for all beneficiaries for a coverage."
        },
        {
          "info": {
            "name": "DELETE /coverage/{coverage_id}/beneficiaries",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.plansource.com/admin/v2/coverage/:coverage_id/beneficiaries",
            "params": [
              {
                "name": "coverage_id",
                "value": "",
                "type": "path",
                "description": "The ID of the coverage."
              },
              {
                "name": "termination_date",
                "value": "",
                "type": "query",
                "description": "The termination date."
              }
            ]
          },
          "docs": "Delete coverage beneficiaries."
        },
        {
          "info": {
            "name": "GET /payroll_coverages_subscriber/{id}",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.plansource.com/admin/v2/payroll_coverages_subscriber/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the subscriber."
              },
              {
                "name": "start_date",
                "value": "",
                "type": "query",
                "description": "Start date of a date range of payroll changes.  ISO 8601 date or RFC 3339 date time date (ex. 2017-12-01 or 2017-12-01T12:30:30-06:00)."
              },
              {
                "name": "end_date",
                "value": "",
                "type": "query",
                "description": "End date of a date range of payroll changes.  ISO 8601 date or RFC 3339 date time (ex. 2017-12-01 or 2017-12-01T12:30:30-06:00)."
              },
              {
                "name": "is_custom_id",
                "value": "",
                "type": "query",
                "description": "Set to true if the {id} in the path is customer generated."
              },
              {
                "name": "current",
                "value": "",
                "type": "query",
                "description": "Return only the subscriber's current coverage records."
              },
              {
                "name": "previous",
                "value": "",
                "type": "query",
                "description": "Return only the subscriber's coverage records that are immediately prior to the current record."
              }
            ]
          },
          "docs": "Retrieve payroll coverages for a subscriber."
        },
        {
          "info": {
            "name": "GET /page_content",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.plansource.com/admin/v2/page_content",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              },
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "SAMLResponse",
                "value": ""
              },
              {
                "name": "RelayState",
                "value": ""
              },
              {
                "name": "Cookie",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "org_page_content_id",
                "value": "",
                "type": "query",
                "description": "Unique id for the org page content (NOTE! This parameter IS required when page_content_lookup_code IS NOT provided)"
              },
              {
                "name": "page_content_lookup_code",
                "value": "",
                "type": "query",
                "description": "Page content lookup code (NOTE! This parameter IS required when org_page_content_id IS NOT provided)"
              },
              {
                "name": "org_plan_year_id",
                "value": "",
                "type": "query",
                "description": "Unique id for the associated plan year"
              },
              {
                "name": "enrollment_type",
                "value": "",
                "type": "query",
                "description": "Enrollment lookup code (NOTE! This parameter IS required when page_content_lookup_code IS EQUAL sub_main)"
              },
              {
                "name": "benefit_lookup_code",
                "value": "",
                "type": "query",
                "description": "Benefit lookup code"
              }
            ]
          },
          "docs": "Returns page content or page contents for the requested view. Blocks are ordered according to their 'slot number' and all fields not set are omitted from the response."
        },
        {
          "info": {
            "name": "PUT /page_content",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.plansource.com/admin/v2/page_content",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              },
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "SAMLResponse",
                "value": ""
              },
              {
                "name": "RelayState",
                "value": ""
              },
              {
                "name": "Cookie",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "org_page_content_id",
                "value": "",
                "type": "query",
                "description": "Unique id for the org page content."
              },
              {
                "name": "org_plan_year_id",
                "value": "",
                "type": "query",
                "description": "Unique id for the associated plan year"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Applies any changes to page content and content block records."
        },
        {
          "info": {
            "name": "GET /content_blocks",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.plansource.com/admin/v2/content_blocks",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              },
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "SAMLResponse",
                "value": ""
              },
              {
                "name": "RelayState",
                "value": ""
              },
              {
                "name": "Cookie",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page number."
              }
            ]
          },
          "docs": "Returns a paginated array of content blocks."
        },
        {
          "info": {
            "name": "PUT /content_block",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.plansource.com/admin/v2/content_block",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              },
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "SAMLResponse",
                "value": ""
              },
              {
                "name": "RelayState",
                "value": ""
              },
              {
                "name": "Cookie",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Applies changes to content block record."
        },
        {
          "info": {
            "name": "POST /administrator",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.plansource.com/admin/v2/administrator",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create an administrator."
        },
        {
          "info": {
            "name": "GET /administrator/{id}",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.plansource.com/admin/v2/administrator/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the administrator to fetch."
              }
            ]
          },
          "docs": "Retrieve data for an administrator."
        },
        {
          "info": {
            "name": "PUT /administrator/{id}",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.plansource.com/admin/v2/administrator/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the administrator to update. The API currently uses the payload's user_name to look up the administrator."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update data for an administrator."
        },
        {
          "info": {
            "name": "PUT /administrator/{id}/disable",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.plansource.com/admin/v2/administrator/:id/disable",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the administrator to update or 1.The API currently uses the payload's user_name to look up the administrator."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Disable an administrator account."
        },
        {
          "info": {
            "name": "GET /administrators",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.plansource.com/admin/v2/administrators",
            "params": [
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Set to page number.  Large responses are parsed into a maximum of 500 administrators or the per_page value for large responses of administrators."
              },
              {
                "name": "per_page",
                "value": "",
                "type": "query",
                "description": "Override of the maximum of 500 administrators returned in a response."
              },
              {
                "name": "changes_since",
                "value": "",
                "type": "query",
                "description": "Will only return admins whose updated_at timestamp is within the number of minutes of the change_since value."
              }
            ]
          },
          "docs": "Retrieve data for all administrators."
        }
      ]
    }
  ],
  "bundled": true
}