Departments | TalentLyft API

TalentLyft API

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

Get department

get

Authorizations

Path parameters

idinteger · int32required

Header parameters

X-TL-CompanyIdguidoptional

Company Id

X-TL-Subdomainguidoptional

Account subdomain

X-TL-UserIdguidoptional

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": [
        {
          "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"
          }
        ]
      }
    }
  ],
  "IsTranslated": true,
  "Translation": {
    "TranslationProperties": [
      "text"
    ],
    "TranslationRequiredProperties": [
      "text"
    ],
    "Translations": [
      {
        "Language": "text",
        "Property": "text",
        "TranslateValue": "text"
      }
    ]
  }
}

Success

Delete department

delete

Authorizations

Path parameters

idinteger · int32required

Header parameters

X-TL-CompanyIdguidoptional

Company Id

X-TL-Subdomainguidoptional

Account subdomain

X-TL-UserIdguidoptional

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

Authorizations

Path parameters

idstringrequired

Header parameters

X-TL-CompanyIdguidoptional

Company Id

X-TL-Subdomainguidoptional

Account subdomain

X-TL-UserIdguidoptional

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": [
        {
          "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"
          }
        ]
      }
    }
  ],
  "IsTranslated": true,
  "Translation": {
    "TranslationProperties": [
      "text"
    ],
    "TranslationRequiredProperties": [
      "text"
    ],
    "Translations": [
      {
        "Language": "text",
        "Property": "text",
        "TranslateValue": "text"
      }
    ]
  }
}

Success

Get departments

get

Authorizations

Query parameters

eidsstring[]optional

External ids

Header parameters

X-TL-CompanyIdguidoptional

Company Id

X-TL-Subdomainguidoptional

Account subdomain

X-TL-UserIdguidoptional

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": [
      {
        "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"
            }
          ]
        }
      }
    ],
    "IsTranslated": true,
    "Translation": {
      "TranslationProperties": [
        "text"
      ],
      "TranslationRequiredProperties": [
        "text"
      ],
      "Translations": [
        {
          "Language": "text",
          "Property": "text",
          "TranslateValue": "text"
        }
      ]
    }
  }
]

Success

Create department

post

Authorizations

Header parameters

X-TL-CompanyIdguidoptional

Company Id

X-TL-Subdomainguidoptional

Account subdomain

X-TL-UserIdguidoptional

Team member id

Body

Idinteger · int32optional

Namestring | nullableoptional

ExternalIdstring | nullableoptional

ParentIdinteger · int32 | nullableoptional

IsTranslatedbooleanoptional

Translationobjectoptional

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": [
        {
          "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"
          }
        ]
      }
    }
  ],
  "IsTranslated": true,
  "Translation": {
    "TranslationProperties": [
      "text"
    ],
    "TranslationRequiredProperties": [
      "text"
    ],
    "Translations": [
      {
        "Language": "text",
        "Property": "text",
        "TranslateValue": "text"
      }
    ]
  }
}

Created

Update department

put

Authorizations

Path parameters

idinteger · int32required

Header parameters

X-TL-CompanyIdguidoptional

Company Id

X-TL-Subdomainguidoptional

Account subdomain

X-TL-UserIdguidoptional

Team member id

Body

Idinteger · int32optional

Namestring | nullableoptional

ExternalIdstring | nullableoptional

ParentIdinteger · int32 | nullableoptional

IsTranslatedbooleanoptional

Translationobjectoptional

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

Get department

Delete department

Get department by external ID

Get departments

Create department

Show child attributes

Update department

Show child attributes