Pipelines | TalentLyft API

TalentLyft API

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

Retrieve all pipelines

get

/v2/pipelines

Authorizations

Query parameters

containsstring

typestring · enum

Options: HiringPipeline, PoolPipeline

includeArchivedboolean · default: false

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/pipelines' \
  --header 'Authorization: YOUR_API_KEY'

200

401

403

500

[
  {
    "Id": 1,
    "Name": "text",
    "Type": "HiringPipeline",
    "Stages": [
      {
        "Id": 1,
        "Name": "text",
        "Type": "Sourced",
        "Ordinal": 1,
        "ActiveCandidates": 1,
        "DisqualifiedCandidates": 1,
        "Candidates": 1,
        "Actions": [
          {
            "Id": 1,
            "Type": "SendEmail",
            "Action": null
          }
        ],
        "Evaluations": [
          {
            "Id": 1,
            "Type": "Scorecard",
            "Evaluation": null
          }
        ],
        "Integrations": [
          {
            "Type": "JobBoards",
            "App": null
          }
        ],
        "HasESignatureDocuments": true,
        "HasJobOfferDocuments": true
      }
    ],
    "IsActive": true
  }
]

Success

Create pipeline

post

/v2/pipelines

Authorizations

Header parameters

X-TL-CompanyIdguid

Company Id

X-TL-Subdomainguid

Account subdomain

X-TL-UserIdguid

Team member id

Body

Idinteger · int32

Namestring | nullable

Typestring · enum

Options: HiringPipeline, PoolPipeline

Stagesobject[] | nullable

IsActiveboolean

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/v2/pipelines' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json-patch+json' \
  --data '{
    "Id": 1,
    "Name": "text",
    "Type": "HiringPipeline",
    "Stages": [
      {
        "Id": 1,
        "Name": "text",
        "Type": "Sourced",
        "Ordinal": 1,
        "ActiveCandidates": 1,
        "DisqualifiedCandidates": 1,
        "Candidates": 1,
        "Actions": [
          {
            "Id": 1,
            "Type": "SendEmail",
            "Action": null
          }
        ],
        "Evaluations": [
          {
            "Id": 1,
            "Type": "Scorecard",
            "Evaluation": null
          }
        ],
        "Integrations": [
          {
            "Type": "JobBoards",
            "App": null
          }
        ],
        "HasESignatureDocuments": true,
        "HasJobOfferDocuments": true
      }
    ],
    "IsActive": true
  }'

201

401

403

422

500

{
  "Id": 1,
  "Name": "text",
  "Type": "HiringPipeline",
  "Stages": [
    {
      "Id": 1,
      "Name": "text",
      "Type": "Sourced",
      "Ordinal": 1,
      "ActiveCandidates": 1,
      "DisqualifiedCandidates": 1,
      "Candidates": 1,
      "Actions": [
        {
          "Id": 1,
          "Type": "SendEmail",
          "Action": null
        }
      ],
      "Evaluations": [
        {
          "Id": 1,
          "Type": "Scorecard",
          "Evaluation": null
        }
      ],
      "Integrations": [
        {
          "Type": "JobBoards",
          "App": null
        }
      ],
      "HasESignatureDocuments": true,
      "HasJobOfferDocuments": true
    }
  ],
  "IsActive": true
}

Created

Get pipeline

get

/v2/pipelines/{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/pipelines/{id}' \
  --header 'Authorization: YOUR_API_KEY'

200

401

403

404

500

{
  "Id": 1,
  "Name": "text",
  "Type": "HiringPipeline",
  "Stages": [
    {
      "Id": 1,
      "Name": "text",
      "Type": "Sourced",
      "Ordinal": 1,
      "ActiveCandidates": 1,
      "DisqualifiedCandidates": 1,
      "Candidates": 1,
      "Actions": [
        {
          "Id": 1,
          "Type": "SendEmail",
          "Action": null
        }
      ],
      "Evaluations": [
        {
          "Id": 1,
          "Type": "Scorecard",
          "Evaluation": null
        }
      ],
      "Integrations": [
        {
          "Type": "JobBoards",
          "App": null
        }
      ],
      "HasESignatureDocuments": true,
      "HasJobOfferDocuments": true
    }
  ],
  "IsActive": true
}

Success

Update pipeline

put

/v2/pipelines/{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

Typestring · enum

Options: HiringPipeline, PoolPipeline

Stagesobject[] | nullable

IsActiveboolean

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/v2/pipelines/{id}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json-patch+json' \
  --data '{
    "Id": 1,
    "Name": "text",
    "Type": "HiringPipeline",
    "Stages": [
      {
        "Id": 1,
        "Name": "text",
        "Type": "Sourced",
        "Ordinal": 1,
        "ActiveCandidates": 1,
        "DisqualifiedCandidates": 1,
        "Candidates": 1,
        "Actions": [
          {
            "Id": 1,
            "Type": "SendEmail",
            "Action": null
          }
        ],
        "Evaluations": [
          {
            "Id": 1,
            "Type": "Scorecard",
            "Evaluation": null
          }
        ],
        "Integrations": [
          {
            "Type": "JobBoards",
            "App": null
          }
        ],
        "HasESignatureDocuments": true,
        "HasJobOfferDocuments": true
      }
    ],
    "IsActive": true
  }'

204

401

403

404

422

500

No body

No Content

Arhive pipeline

delete

/v2/pipelines/{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/pipelines/{id}' \
  --header 'Authorization: YOUR_API_KEY'

202

401

403

404

500

No body

Accepted

Retrieve all pipelines

Create pipeline

Show child attributes

Get pipeline

Update pipeline

Show child attributes

Arhive pipeline