Sign in

v1

latestOpenAPI 3.0.22026-07-26191278525.6 KB
Entity Profile Application

Get Entity Profile Application

Given an entity profile application id, it returns all attributes of the entity profile application

get/api/v2/core/entity-profile-applications/{entityType}/{applicationId}

Path parameters

applicationIdstring required

Entity profile application id of application in Eightfold

entityType'planned_event' required

Entity type of the entity profile application (e.g. planned_event)

Query parameters

includestring

Include additional fields in the response. Possible values are customInfo

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

statusstring nullable

status of the application

idinteger nullable

object id of the profile application

namespacestring nullable

namespace of profile application

stagestring nullable
applicationTimeinteger nullable

application timestamp of profile application

entityIdinteger nullable

entity id of profile application

lastModifiedTimeinteger nullable

last modified timestamp of profile application

customInfoobject nullable

custom info for the application

profileIdinteger nullable

profile id of candidate

groupIdstring nullable
candidateIdstring nullable

candidate id of profile application

commentstring nullable

comment added during stage advance

currentStagestring nullable

current stage of profile application

applicationIdinteger nullable

application id of profile application