Departments

An organization’s departments.

get
Get departments

https://api.talentlyft.com/v2/departments
List all of an organization’s departments.
Request
Response
Headers
Authorization
required
string
Authentication Bearer token
Query Parameters
eids
optional
array
External ids
200: OK
[
{
"Id": 23,
"Name": "Marketing",
"ExternalId": null,
"ParentId": null,
"Children": null
},
{
"Id": 24,
"Name": "Sales",
"ExternalId": null,
"ParentId": null,
"Children": null
}
]
401: Unauthorized
{
"Message": "Unauthorized"
}
403: Forbidden
{
"Message": "Forbidden"
}

get
Get department

https://api.talentlyft.com/v2/departments/:id
Retrieve a department by its id.
Request
Response
Path Parameters
id
required
string
Unique identifier
Headers
Authorization
required
string
Authentication Bearer token
200: OK
{
"Id": 23,
"Name": "Marketing",
"ExternalId": null,
"ParentId": null,
"Children": null
}
401: Unauthorized
{
"Message": "Unauthorized"
}
403: Forbidden
{
"Message": "Forbidden"
}
404: Not Found
{
"Message": "Not Found"
}

get
Get department by external id

https://api.talentlyft.com/v2/departments/:external_id/external
Retrieve a department by its external id.
Request
Response
Path Parameters
external_id
required
string
External id
Headers
Authorization
required
string
Authentication Bearer token
200: OK
{
"Id": 23,
"Name": "Marketing",
"ExternalId": null,
"ParentId": null,
"Children": null
}
401: Unauthorized
{
"Message": "Unauthorized"
}
403: Forbidden
{
"Message": "Forbidden"
}
404: Not Found
{
"Message": "Not Found"
}

post
Create department

https://api.talentlyft.com/v2/departments
Create a new department
Request
Response
Headers
Authorization
required
string
Authentication Bearer token
Body Parameters
Name
required
string
Department name
ExternalId
optional
string
Department external id
ParentId
optional
string
Department parent id
201: Created
{
"Id": 23,
"Name": "Marketing",
"ExternalId": null,
"ParentId": null,
"Children": null
}
401: Unauthorized
{
"Message": "Unauthorized"
}
403: Forbidden
{
"Message": "Forbidden"
}

put
Update department

https://api.talentlyft.com/v2/departments/:id
Update existing department
Request
Response
Path Parameters
id
required
string
Unique identifier
Headers
Authorization
required
string
Authentication Bearer token
Body Parameters
Name
required
string
Department name
ExternalId
optional
string
Department external id
ParentId
optional
string
Department parent id
204: No Content
401: Unauthorized
{
"Message": "Unauthorized"
}
403: Forbidden
{
"Message": "Forbidden"
}
404: Not Found
{
"Message": "Not Found"
}

delete
Delete department

https://api.talentlyft.com/v2/departments/:id
Delete a Department
Request
Response
Path Parameters
id
required
string
Unique identifier
Headers
Authorization
required
string
Authentication Bearer token
204: No Content
401: Unauthorized
{
"Message": "Unauthorized"
}
403: Forbidden
{
"Message": "Forbidden"
}
404: Not Found
{
"Message": "Not Found"
}