v1

latestOpenAPI 3.0.22026-07-26191278525.6 KB
Foundational Data

Get Foundational Data

Given an external id, it returns Foundational Data object

get/api/v2/ats/foundational-data/{externalId}

Path parameters

externalIdstring required

External ID of the Foundational Data

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

externalIdstring nullable

External ID of the foundational data

statusstring nullable

Status of the foundational data

createdAtinteger nullable

Created timestamp

typestring nullable

Type of the foundational data

updatedAtinteger nullable

Updated timestamp

descriptionstring nullable

Description of the foundational data

titlestring nullable

Title of the foundational data