Departments | TalentLyft API

TalentLyft API

Help Login Register Go to App Go to TalentLyft Request a Demo

Get departments

get

/v2/departments

Authorizations

Query parameters

eidsstring[]

External ids

Header parameters

X-TL-CompanyIdguid

Company Id

X-TL-Subdomainguid

Account subdomain

X-TL-UserIdguid

Team member id

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v2/departments' \
  --header 'Authorization: YOUR_API_KEY'

200

401

403

500

[
  {
    "Id": 1,
    "Name": "text",
    "ExternalId": "text",
    "ParentId": 1,
    "Children": [
      "[Circular Reference]"
    ],
    "IsTranslated": true,
    "Translation": {
      "TranslationProperties": [
        "text"
      ],
      "TranslationRequiredProperties": [
        "text"
      ],
      "Translations": [
        {
          "Language": "text",
          "Property": "text",
          "TranslateValue": "text"
        }
      ]
    }
  }
]

Success

Create department

post

/v2/departments

Authorizations

Header parameters

X-TL-CompanyIdguid

Company Id

X-TL-Subdomainguid

Account subdomain

X-TL-UserIdguid

Team member id

Body

Idinteger · int32

Namestring | nullable

ExternalIdstring | nullable

ParentIdinteger · int32 | nullable

IsTranslatedboolean

Translationobject

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/v2/departments' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json-patch+json' \
  --data '{
    "Id": 1,
    "Name": "text",
    "ExternalId": "text",
    "ParentId": 1,
    "IsTranslated": true,
    "Translation": {
      "TranslationProperties": [
        "text"
      ],
      "TranslationRequiredProperties": [
        "text"
      ],
      "Translations": [
        {
          "Language": "text",
          "Property": "text",
          "TranslateValue": "text"
        }
      ]
    }
  }'

201

401

403

422

500

{
  "Id": 1,
  "Name": "text",
  "ExternalId": "text",
  "ParentId": 1,
  "Children": [
    {
      "Id": 1,
      "Name": "text",
      "ExternalId": "text",
      "ParentId": 1,
      "Children": "[Circular Reference]",
      "IsTranslated": true,
      "Translation": {
        "TranslationProperties": [
          "text"
        ],
        "TranslationRequiredProperties": [
          "text"
        ],
        "Translations": [
          {
            "Language": "text",
            "Property": "text",
            "TranslateValue": "text"
          }
        ]
      }
    }
  ],
  "IsTranslated": true,
  "Translation": {
    "TranslationProperties": [
      "text"
    ],
    "TranslationRequiredProperties": [
      "text"
    ],
    "Translations": [
      {
        "Language": "text",
        "Property": "text",
        "TranslateValue": "text"
      }
    ]
  }
}

Created

Get department

get

/v2/departments/{id}

Authorizations

Path parameters

idinteger · int32required

Header parameters

X-TL-CompanyIdguid

Company Id

X-TL-Subdomainguid

Account subdomain

X-TL-UserIdguid

Team member id

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v2/departments/{id}' \
  --header 'Authorization: YOUR_API_KEY'

200

401

403

404

500

{
  "Id": 1,
  "Name": "text",
  "ExternalId": "text",
  "ParentId": 1,
  "Children": [
    {
      "Id": 1,
      "Name": "text",
      "ExternalId": "text",
      "ParentId": 1,
      "Children": "[Circular Reference]",
      "IsTranslated": true,
      "Translation": {
        "TranslationProperties": [
          "text"
        ],
        "TranslationRequiredProperties": [
          "text"
        ],
        "Translations": [
          {
            "Language": "text",
            "Property": "text",
            "TranslateValue": "text"
          }
        ]
      }
    }
  ],
  "IsTranslated": true,
  "Translation": {
    "TranslationProperties": [
      "text"
    ],
    "TranslationRequiredProperties": [
      "text"
    ],
    "Translations": [
      {
        "Language": "text",
        "Property": "text",
        "TranslateValue": "text"
      }
    ]
  }
}

Success

Update department

put

/v2/departments/{id}

Authorizations

Path parameters

idinteger · int32required

Header parameters

X-TL-CompanyIdguid

Company Id

X-TL-Subdomainguid

Account subdomain

X-TL-UserIdguid

Team member id

Body

Idinteger · int32

Namestring | nullable

ExternalIdstring | nullable

ParentIdinteger · int32 | nullable

IsTranslatedboolean

Translationobject

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/v2/departments/{id}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json-patch+json' \
  --data '{
    "Id": 1,
    "Name": "text",
    "ExternalId": "text",
    "ParentId": 1,
    "IsTranslated": true,
    "Translation": {
      "TranslationProperties": [
        "text"
      ],
      "TranslationRequiredProperties": [
        "text"
      ],
      "Translations": [
        {
          "Language": "text",
          "Property": "text",
          "TranslateValue": "text"
        }
      ]
    }
  }'

204

401

403

404

422

500

No body

No Content

Delete department

delete

/v2/departments/{id}

Authorizations

Path parameters

idinteger · int32required

Header parameters

X-TL-CompanyIdguid

Company Id

X-TL-Subdomainguid

Account subdomain

X-TL-UserIdguid

Team member id

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/v2/departments/{id}' \
  --header 'Authorization: YOUR_API_KEY'

204

401

403

404

500

No body

No Content

Get department by external ID

get

/v2/departments/{id}/external

Authorizations

Path parameters

idstringrequired

Header parameters

X-TL-CompanyIdguid

Company Id

X-TL-Subdomainguid

Account subdomain

X-TL-UserIdguid

Team member id

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v2/departments/{id}/external' \
  --header 'Authorization: YOUR_API_KEY'

200

401

403

404

500

{
  "Id": 1,
  "Name": "text",
  "ExternalId": "text",
  "ParentId": 1,
  "Children": [
    {
      "Id": 1,
      "Name": "text",
      "ExternalId": "text",
      "ParentId": 1,
      "Children": "[Circular Reference]",
      "IsTranslated": true,
      "Translation": {
        "TranslationProperties": [
          "text"
        ],
        "TranslationRequiredProperties": [
          "text"
        ],
        "Translations": [
          {
            "Language": "text",
            "Property": "text",
            "TranslateValue": "text"
          }
        ]
      }
    }
  ],
  "IsTranslated": true,
  "Translation": {
    "TranslationProperties": [
      "text"
    ],
    "TranslationRequiredProperties": [
      "text"
    ],
    "Translations": [
      {
        "Language": "text",
        "Property": "text",
        "TranslateValue": "text"
      }
    ]
  }
}

Success

Get departments

Create department

Show child attributes

Get department

Update department

Show child attributes

Delete department

Get department by external ID