v1

latestOpenAPI 3.0.22026-07-26191278525.6 KB
Profile Tag

Get Profile Tag

Given a profile tag id of a candidate, it returns all attributes of the profile tag

get/api/v2/core/profile-tags/{profileTagId}

Path parameters

profileTagIdstring required

profile tag ID of tag 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

creatorEmailstring nullable

creator email of candidate Tag

idstring required

Tag id of candidate

tagstring nullable

candidate Tag

tagSubtypestring nullable

Tag subtype

profileIdstring nullable

candidate profile Id

tagTypestring nullable

Type of candidate Tag

urlstring nullable

url

groupIdstring nullable

group id

positionIdstring nullable

position id

createdTimeinteger nullable required

Created time of candidate Tag