Sign in

v1

latestOpenAPI 3.0.22026-07-26191278525.6 KB
Hiring Company

Get Hiring Company

Given a Hiring Company Group Id, it returns all attributes of the Hiring Company

get/api/v2/etx/hiring_company/{hiringCompanyGroupId}

Path parameters

hiringCompanyGroupIdstring required

GroupID of a Hiring Company in Eightfold

Query parameters

excludestring

Exclude specific fields in the response. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.

keyListstring

Allows selective control over the fields returned in the API response. If the keyList is empty, all fields will be returned. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.

Headers

Authorizationstring required

The secret key to access the api. It starts with the bearer token

Response

OK

createdTsinteger nullable

Datetime when the Hiring Company was created

rejectReasonstring nullable

Reason for rejecting the Hiring Company

onholdReasonstring nullable

Reason for putting the Hiring Company on hold

statusstring nullable

Status of the Hiring Company

verifiedInfoobject nullable

Verified information of the Hiring Company

statusChangeBystring nullable

User who changed the status of the Hiring Company

updatedTsinteger nullable

Datetime when the Hiring Company was updated

organizationNamestring nullable

Name of the Hiring Company

hiringCompanyGroupIdstring nullable

Group Id of the Hiring Company

deletedTsinteger nullable

Datetime when the Hiring Company was deleted

onholdStatusstring nullable

Status of the Hiring Company when on hold

primaryExchangeAdminstring nullable

Primary Exchange Admin

unverifiedInfoobject nullable

Unverified information of the Hiring Company

statusChangeTsinteger nullable

Datetime when the status of the Hiring Company was changed