Console
    Contact Us Start free

    REST Resource: projects.companies

    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 (  CompanySize 
 
) 
 , 
 "headquartersAddress" 
 : 
 string 
 , 
 "hiringAgency" 
 : 
 boolean 
 , 
 "eeoText" 
 : 
 string 
 , 
 "websiteUri" 
 : 
 string 
 , 
 "careerSiteUri" 
 : 
 string 
 , 
 "imageUri" 
 : 
 string 
 , 
 "keywordSearchableJobCustomAttributes" 
 : 
 [ 
 string 
 ] 
 , 
 "derivedInfo" 
 : 
 { 
 object (  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 ( 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 DerivedInfo.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 Job.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 ( 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 (  Location 
 
) 
 } 
 }
    Fields
    headquartersLocation

    object ( Location )

    A structured headquarters location of the company, resolved from [Company.hq_location][] if provided.

    Methods

    create

    		Creates a new company entity.

    delete

    		Deletes specified company.

    get

    		Retrieves specified company.

    list

    		Lists all companies associated with the service account.

    patch

    		Updates specified company.
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: