## List employers `employers.list(**kwargs) -> PageNumberPage` **get** `/v1/employers` Retrieves a paginated list of all employers belonging to the authenticated organization. Results are sorted by creation date (newest first) and paginated using page and limit parameters. ### Parameters - `limit: Integer` Items per page (default: 20, max: 100) - `page: Integer` Page number (default: 1) ### Returns - `class Employer` Serializer for Employer entity in public API responses. - `id: String` Unique employer identifier with 'empr_' prefix - `active: bool` Whether the employer is currently active in the system - `address: { address_line_1, city, state, 2 more}` Nested address within EmployerSerializer. - `address_line_1: String` Primary street address - `city: String` City name - `state: String` Two-letter state code (e.g., CA, NY) - `zipcode: String` ZIP code (5 or 9 digit) - `address_line_2: String` Secondary street address (apt, suite, etc.) - `created_at: Time` Timestamp when the employer was created - `ein: String` Employer Identification Number (masked in responses) - `eligibility_policy_id: String` ID of the benefit eligibility policy (epol_*), if assigned - `legal_name: String` Legal business name for compliance and tax purposes - `name: String` Display name of the employer - `organization_id: String` ID of the parent organization (org_*) - `updated_at: Time` Timestamp when the employer was last updated - `email: String` Email address for billing and communications - `phone_number: String` Employer phone number (E.164 format recommended) - `reference_id: String` Partner-assigned reference ID for the employer ### Example ```ruby require "vitable_connect" vitable_connect = VitableConnect::Client.new( api_key: "My API Key", environment: "environment_1" # defaults to "production" ) page = vitable_connect.employers.list puts(page) ``` #### Response ```json { "data": [ { "id": "empr_abc123def456", "organization_id": "org_xyz789", "name": "Acme Corporation", "legal_name": "Acme Corporation Inc.", "ein": "XX-XXX1234", "reference_id": "partner-emp-001", "email": "hr@acme.com", "phone_number": "4155550100", "active": true, "address": { "address_line_1": "123 Main Street", "address_line_2": "Suite 100", "city": "San Francisco", "state": "CA", "zipcode": "94102" }, "eligibility_policy_id": "epol_policy123", "created_at": "2024-01-15T10:30:00Z", "updated_at": "2024-06-20T14:45:00Z" }, { "id": "empr_def456ghi789", "organization_id": "org_xyz789", "name": "TechStart Inc", "legal_name": "TechStart Incorporated", "ein": "XX-XXX5678", "reference_id": null, "email": "contact@techstart.com", "phone_number": null, "active": true, "address": { "address_line_1": "456 Innovation Drive", "address_line_2": "", "city": "Austin", "state": "TX", "zipcode": "78701" }, "eligibility_policy_id": null, "created_at": "2024-03-01T09:00:00Z", "updated_at": "2024-03-01T09:00:00Z" } ], "pagination": { "page": 1, "limit": 20, "total": 2, "total_pages": 1 } } ```