Pipelines

Retrieve all pipelines

get

Authorizations

Query parameters

containsstringOptional

typestring · enumOptionalPossible values:

includeArchivedbooleanOptionalDefault: false

Header parameters

X-TL-CompanyIdguidOptional

Company Id

X-TL-SubdomainguidOptional

Account subdomain

X-TL-UserIdguidOptional

Team member id

Responses

200

Success

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Server Error

application/json

get

HTTPcURLJavaScriptPython

GET /v2/pipelines HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "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
          }
        ],
        "ActionsAfterDaysWaitingInStage": [
          {
            "Id": 1,
            "Type": "SendEmail",
            "Action": null
          }
        ],
        "Evaluations": [
          {
            "Id": 1,
            "Type": "Scorecard",
            "Evaluation": null
          }
        ],
        "Integrations": [
          {
            "Type": "JobBoards",
            "App": null
          }
        ],
        "HasESignatureDocuments": true,
        "HasJobOfferDocuments": true,
        "DaysWaitingInStage": 1,
        "DontSkipStage": true
      }
    ],
    "IsActive": true
  }
]

Create pipeline

post

Authorizations

Header parameters

X-TL-CompanyIdguidOptional

Company Id

X-TL-SubdomainguidOptional

Account subdomain

X-TL-UserIdguidOptional

Team member id

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

Idinteger · int32Optional

Namestring | nullableOptional

Typestring · enumOptionalPossible values:

IsActivebooleanOptional

Responses

201

Created

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

422

Client Error

application/json

500

Server Error

application/json

post

HTTPcURLJavaScriptPython

POST /v2/pipelines HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 517

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

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

{
  "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
        }
      ],
      "ActionsAfterDaysWaitingInStage": [
        {
          "Id": 1,
          "Type": "SendEmail",
          "Action": null
        }
      ],
      "Evaluations": [
        {
          "Id": 1,
          "Type": "Scorecard",
          "Evaluation": null
        }
      ],
      "Integrations": [
        {
          "Type": "JobBoards",
          "App": null
        }
      ],
      "HasESignatureDocuments": true,
      "HasJobOfferDocuments": true,
      "DaysWaitingInStage": 1,
      "DontSkipStage": true
    }
  ],
  "IsActive": true
}

Get pipeline

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

200

Success

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

500

Server Error

application/json

get

HTTPcURLJavaScriptPython

GET /v2/pipelines/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "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
        }
      ],
      "ActionsAfterDaysWaitingInStage": [
        {
          "Id": 1,
          "Type": "SendEmail",
          "Action": null
        }
      ],
      "Evaluations": [
        {
          "Id": 1,
          "Type": "Scorecard",
          "Evaluation": null
        }
      ],
      "Integrations": [
        {
          "Type": "JobBoards",
          "App": null
        }
      ],
      "HasESignatureDocuments": true,
      "HasJobOfferDocuments": true,
      "DaysWaitingInStage": 1,
      "DontSkipStage": true
    }
  ],
  "IsActive": true
}

Update pipeline

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

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

Idinteger · int32Optional

Namestring | nullableOptional

Typestring · enumOptionalPossible values:

IsActivebooleanOptional

Responses

204

No Content

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

422

Client Error

application/json

500

Server Error

application/json

put

HTTPcURLJavaScriptPython

PUT /v2/pipelines/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 517

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

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

No content

Arhive pipeline

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

202

Accepted

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

500

Server Error

application/json

delete

HTTPcURLJavaScriptPython

DELETE /v2/pipelines/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

No content