--- updatedAt: 2026-02-10T18:50:36.000Z agentTools: siteIndex: https://developer.paylocity.com/llms.txt projectIndex: https://developer.paylocity.com/integrations/llms.txt --- # Get Company Information **Summary Description** The Get Company Information API endpoint provides access to specific company details. Users can retrieve a wide range of company information, including: company name, address, industry, (EIN) Employer Identification Number, and more. **Use Cases** - Once the developer has company information, they can update their system with the latest earning codes. To update the earning codes in their system and they need to know what earning codes are available in Paylocity. - After getting company data, clients are use the company specific schema to pull the information into their UI to expose to a user. - Once the developer has company information, developers can add a New Employee to Paylocity and the system requires them to include the Benefit Class assigned in Paylocity for the New Employee. # OpenAPI definition ```json { "openapi": "3.0.1", "info": { "title": "Company Level Information", "version": "v1" }, "servers": [ { "url": "dc1demogwext.paylocity.com" } ], "paths": { "/apiHub/corehr/v1/companies/{companyId}": { "get": { "tags": [ "Company Information" ], "summary": "Get Company Information", "description": "**Summary Description**\n\nThe Get Company Information API endpoint provides access to specific company details. Users can retrieve a wide range of company information, including: company name, address, industry, (EIN) Employer Identification Number, and more.\n\n**Use Cases**\n\n- Once the developer has company information, they can update their system with the latest earning codes. To update the earning codes in their system and they need to know what earning codes are available in Paylocity.\n- After getting company data, clients are use the company specific schema to pull the information into their UI to expose to a user.\n- Once the developer has company information, developers can add a New Employee to Paylocity and the system requires them to include the Benefit Class assigned in Paylocity for the New Employee.\n", "x-explorer-enabled": false, "parameters": [ { "name": "companyId", "in": "path", "description": "The Paylocity Company Identifier. This is the unique value provided by Paylocity to each specific Payroll Entity.\r\n **Allowable Values:**\r\n 9 char max.", "required": true, "schema": { "type": "string" }, "example": "A12345" }, { "name": "testMode", "in": "header", "description": "If true all responses are mocked and generated randomly.", "schema": { "type": "boolean" } }, { "name": "Authorization", "in": "header", "description": "Authorization token. Ex. Bearer ...", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyInformationDto" } } } } } } } }, "components": { "schemas": { "CompanyInformationAddressDto": { "type": "object", "properties": { "type": { "type": "string", "description": "Specifies the type of address, such as \"Home,\" \"Work,\" \"Billing,\" or \"Shipping.\" It helps categorize and differentiate between different address entries.", "nullable": true }, "label": { "type": "string", "description": "Allows users to assign a custom label or name to the address entry for easy reference. It can be used for additional context or organization, such as \"Home Office\" or \"Office Address.\"", "nullable": true }, "line1": { "type": "string", "description": "This field represents the first line of the street address, including the house or building number and the street name. It is an essential part of any physical address.", "nullable": true }, "line2": { "type": "string", "description": "Optional field that allows for additional address information, such as an apartment number, suite, or any other details that help further pinpoint the location.", "nullable": true }, "mailStopCode": { "type": "string", "description": "Represents the specific alphanumeric code or identifier assigned to a mail stop within an organization or institution. Mail stop codes are often used to route internal or interoffice mail to the correct destination.", "nullable": true }, "locality": { "type": "string", "description": "Area or neighborhood.", "nullable": true }, "state": { "type": "string", "description": "Represents the state, region, or province in which the locality is located. It provides additional context for the geographical location and is especially relevant in larger countries or regions.", "nullable": true }, "postalCode": { "type": "string", "description": "Contains the alphanumeric or numeric code that uniquely identifies a specific postal or ZIP code. Postal codes are used for mail sorting and delivery, helping postal services direct mail to the correct geographic.", "nullable": true }, "country": { "type": "string", "description": "Indicates the name of the country where the locality is situated. It specifies the broader national context for the locality.", "nullable": true }, "county": { "type": "string", "description": "Contains the name of the county, which is a specific administrative or geographical region within a larger state or country. Counties are often used for administrative and geographical purposes.", "nullable": true } }, "additionalProperties": { "type": "object", "nullable": true } }, "CompanyInformationDto": { "type": "object", "properties": { "companyId": { "type": "string", "description": "The Paylocity Company Identifier. This is the unique value provided by Paylocity to each specific Payroll Entity.", "nullable": true }, "companyName": { "type": "string", "description": "Represents the official name of the company or organization. It typically includes the full legal name of the company and is used to uniquely identify the entity.", "nullable": true }, "phone": { "type": "string", "description": "Contains the numerical digits that make up the phone number. It represents the unique identifier for contacting an individual or entity by phone.", "nullable": true }, "webTimeCo": { "type": "string", "description": "The web time company ID.", "nullable": true }, "clientId": { "type": "integer", "description": "ClientId is the company set ID when the client is a company set. If the client is a standalone company, then clientId will be the same as the companyId.", "format": "int32", "nullable": true }, "parentCompanySetId": { "type": "string", "description": "Indicates the company set to which the company belongs. It helps organize and categorize companies into sets or groups.", "nullable": true }, "serviceStartDate": { "type": "string", "description": "Represents the date when the company's services or operations officially commenced. It is useful for tracking the start of business activities.", "format": "date-time", "nullable": true }, "ein": { "type": "string", "description": "Stands for Employee Identification Number, a unique identifier assigned to businesses for tax purposes in the United States. It helps identify the company for tax reporting.", "nullable": true }, "dba": { "type": "string", "description": "Represents the Doing Business As (DBA) name of the company. It is the name under which the company conducts business if it differs from its legal name.", "nullable": true }, "naics": { "type": "integer", "description": "Refers to the North American Industry Classification System (NAICS) code. It classifies the company's primary industry or business sector.", "format": "int32", "nullable": true }, "industryType": { "type": "string", "description": "Provides information about the type or category of industry in which the company operates. It helps categorize businesses further.", "nullable": true }, "accessEndDate": { "type": "string", "description": "Specifies the date when access to a particular system or service will expire for the company.", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "description": "Represents the date when a specific service or agreement with the company will conclude or expire.", "format": "date-time", "nullable": true }, "firstCheckDate": { "type": "string", "description": "First Check Date refers to the day a company's initial billing begins.", "format": "date-time", "nullable": true }, "status": { "type": "string", "description": "Indicates whether the company is currently active or inactive. It serves as a binary indicator of the company's operational status.", "nullable": true }, "entityType": { "type": "string", "description": "Specifies the legal type of entity to which the company belongs. Common entity types include \"Corporation,\" \"Limited Liability Company (LLC),\" and others.", "nullable": true }, "address": { "$ref": "#/components/schemas/CompanyInformationAddressDto" }, "relationships": { "type": "array", "items": { "$ref": "#/components/schemas/RelationshipDto" }, "description": "Refers to the company relationships model, which may encompass various connections or associations between the company and other entities.", "nullable": true } }, "additionalProperties": { "type": "object", "nullable": true } }, "RelationshipDto": { "type": "object", "properties": { "description": { "type": "string", "description": "Provides a textual description of the relationship between the company and other entities. It offers additional context or details about the nature of the connection.", "nullable": true }, "relationshipType": { "enum": [ "Unknown", "Payroll" ], "type": "string", "description": "Describes the type of relationship that the company has with other entities. It can be categorized as \"unknown\" or \"Payroll”." } }, "additionalProperties": { "type": "object", "nullable": true } } } } } ```