# REST Resource: projects.companies

- [Resource: Company](https://docs.cloud.google.com/talent-solution/job-search/v3/docs/reference/rest/v3p1beta1/projects.companies#Company)
  - [JSON representation](https://docs.cloud.google.com/talent-solution/job-search/v3/docs/reference/rest/v3p1beta1/projects.companies#Company.SCHEMA_REPRESENTATION)
- [CompanySize](https://docs.cloud.google.com/talent-solution/job-search/v3/docs/reference/rest/v3p1beta1/projects.companies#CompanySize)
- [DerivedInfo](https://docs.cloud.google.com/talent-solution/job-search/v3/docs/reference/rest/v3p1beta1/projects.companies#DerivedInfo)
  - [JSON representation](https://docs.cloud.google.com/talent-solution/job-search/v3/docs/reference/rest/v3p1beta1/projects.companies#DerivedInfo.SCHEMA_REPRESENTATION)
- [Methods](https://docs.cloud.google.com/talent-solution/job-search/v3/docs/reference/rest/v3p1beta1/projects.companies#METHODS_SUMMARY)

## Resource: Company

A Company resource represents a company in the service. A company is the entity that owns job postings, that is, the hiring entity responsible for employing applicants for the job position.

| JSON representation ||
|---|---|
| ``` { "name": string, "displayName": string, "externalId": string, "size": enum (`https://docs.cloud.google.com/talent-solution/job-search/v3/docs/reference/rest/v3p1beta1/projects.companies#CompanySize`), "headquartersAddress": string, "hiringAgency": boolean, "eeoText": string, "websiteUri": string, "careerSiteUri": string, "imageUri": string, "keywordSearchableJobCustomAttributes": [ string ], "derivedInfo": { object (`https://docs.cloud.google.com/talent-solution/job-search/v3/docs/reference/rest/v3p1beta1/projects.companies#DerivedInfo`) }, "suspended": boolean } ``` |

| Fields ||
|---|---|
| `name` | `string` Required during company update. The resource name for a company. This is generated by the service when a company is created. The format is "projects/{projectId}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". |
| `displayName` | `string` Required. The display name of the company, for example, "Google LLC". |
| `externalId` | `string` Required. Client side company identifier, used to uniquely identify the company. The maximum number of allowed characters is 255. |
| `size` | ``enum (`https://docs.cloud.google.com/talent-solution/job-search/v3/docs/reference/rest/v3p1beta1/projects.companies#CompanySize`)`` Optional. The employer's company size. |
| `headquartersAddress` | `string` Optional. The street address of the company's main headquarters, which may be different from the job location. The service attempts to geolocate the provided address, and populates a more specific location wherever possible in `https://docs.cloud.google.com/talent-solution/job-search/v3/docs/reference/rest/v3p1beta1/projects.companies#DerivedInfo.FIELDS.headquarters_location`. |
| `hiringAgency` | `boolean` Optional. Set to true if it is the hiring agency that post jobs for other employers. Defaults to false if not provided. |
| `eeoText` | `string` Optional. Equal Employment Opportunity legal disclaimer text to be associated with all jobs, and typically to be displayed in all roles. The maximum number of allowed characters is 500. |
| `websiteUri` | `string` Optional. The URI representing the company's primary web site or home page, for example, "https://www.google.com". The maximum number of allowed characters is 255. |
| `careerSiteUri` | `string` Optional. The URI to employer's career site or careers page on the employer's web site, for example, "https://careers.google.com". |
| `imageUri` | `string` Optional. A URI that hosts the employer's company logo. |
| `keywordSearchableJobCustomAttributes[]` | `string` Optional. A list of keys of filterable `https://docs.cloud.google.com/talent-solution/job-search/v3/docs/reference/rest/v3p1beta1/projects.jobs#Job.FIELDS.custom_attributes`, whose corresponding `stringValues` are used in keyword search. Jobs with `stringValues` under these specified field keys are returned if any of the values matches the search keyword. Custom field values with parenthesis, brackets and special symbols won't be properly searchable, and those keyword queries need to be surrounded by quotes. |
| `derivedInfo` | ``object (`https://docs.cloud.google.com/talent-solution/job-search/v3/docs/reference/rest/v3p1beta1/projects.companies#DerivedInfo`)`` Output only. Derived details about the company. |
| `suspended` | `boolean` Output only. Indicates whether a company is flagged to be suspended from public availability by the service when job content appears suspicious, abusive, or spammy. |

## CompanySize

An enum that represents the size of the company.

| Enums ||
|---|---|
| `COMPANY_SIZE_UNSPECIFIED` | Default value if the size is not specified. |
| `MINI` | The company has less than 50 employees. |
| `SMALL` | The company has between 50 and 99 employees. |
| `SMEDIUM` | The company has between 100 and 499 employees. |
| `MEDIUM` | The company has between 500 and 999 employees. |
| `BIG` | The company has between 1,000 and 4,999 employees. |
| `BIGGER` | The company has between 5,000 and 9,999 employees. |
| `GIANT` | The company has 10,000 or more employees. |

## DerivedInfo

Derived details about the company.

| JSON representation ||
|---|---|
| ``` { "headquartersLocation": { object (`https://docs.cloud.google.com/talent-solution/job-search/v3/docs/reference/rest/v3p1beta1/Location`) } } ``` |

| Fields ||
|---|---|
| `headquartersLocation` | ``object (`https://docs.cloud.google.com/talent-solution/job-search/v3/docs/reference/rest/v3p1beta1/Location`)`` A structured headquarters location of the company, resolved from \[Company.hq_location\]\[\] if provided. |

| ## Methods ||
|---|---|
| ### `https://docs.cloud.google.com/talent-solution/job-search/v3/docs/reference/rest/v3p1beta1/projects.companies/create` | Creates a new company entity. |
| ### `https://docs.cloud.google.com/talent-solution/job-search/v3/docs/reference/rest/v3p1beta1/projects.companies/delete` | Deletes specified company. |
| ### `https://docs.cloud.google.com/talent-solution/job-search/v3/docs/reference/rest/v3p1beta1/projects.companies/get` | Retrieves specified company. |
| ### `https://docs.cloud.google.com/talent-solution/job-search/v3/docs/reference/rest/v3p1beta1/projects.companies/list` | Lists all companies associated with the service account. |
| ### `https://docs.cloud.google.com/talent-solution/job-search/v3/docs/reference/rest/v3p1beta1/projects.companies/patch` | Updates specified company. |