Pipelines

Retrieve all pipelines

GET/v2/pipelines

Query parameters

Header parameters

Response

200401403500

Success

Body

application/json

Idinteger (int32)

Namenullable string

TypeTalentLyft.Data.Enumerators.Company.PipelineTypes (enum)

HiringPipelinePoolPipeline

Stagesnullable array of Adopto.Common.Api.Dto.Settings.StageDto (object)

IsActiveboolean

Request

JavaScriptCurlPython

const response = await fetch('/v2/pipelines', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401403500

[
  {
    "Id": 0,
    "Name": "text",
    "Type": "HiringPipeline",
    "Stages": [
      {
        "Id": 0,
        "Name": "text",
        "Type": "Sourced",
        "Ordinal": 0,
        "ActiveCandidates": 0,
        "DisqualifiedCandidates": 0,
        "Candidates": 0,
        "Actions": [
          {
            "Id": 0,
            "Type": "SendEmail"
          }
        ],
        "Evaluations": [
          {
            "Id": 0,
            "Type": "Scorecard"
          }
        ],
        "Integrations": [
          {
            "Type": "JobBoards"
          }
        ],
        "HasESignatureDocuments": false,
        "HasJobOfferDocuments": false
      }
    ],
    "IsActive": false
  }
]

Create pipeline

POST/v2/pipelines

Header parameters

Body

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

Idinteger (int32)

Namenullable string

TypeTalentLyft.Data.Enumerators.Company.PipelineTypes (enum)

HiringPipelinePoolPipeline

Stagesnullable array of Adopto.Common.Api.Dto.Settings.StageDto (object)

IsActiveboolean

Response

201401403422500

Created

Body

application/json

Idinteger (int32)

Namenullable string

TypeTalentLyft.Data.Enumerators.Company.PipelineTypes (enum)

HiringPipelinePoolPipeline

Stagesnullable array of Adopto.Common.Api.Dto.Settings.StageDto (object)

IsActiveboolean

Request

JavaScriptCurlPython

const response = await fetch('/v2/pipelines', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json-patch+json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201401403422500

{
  "Id": 0,
  "Name": "text",
  "Type": "HiringPipeline",
  "Stages": [
    {
      "Id": 0,
      "Name": "text",
      "Type": "Sourced",
      "Ordinal": 0,
      "ActiveCandidates": 0,
      "DisqualifiedCandidates": 0,
      "Candidates": 0,
      "Actions": [
        {
          "Id": 0,
          "Type": "SendEmail"
        }
      ],
      "Evaluations": [
        {
          "Id": 0,
          "Type": "Scorecard"
        }
      ],
      "Integrations": [
        {
          "Type": "JobBoards"
        }
      ],
      "HasESignatureDocuments": false,
      "HasJobOfferDocuments": false
    }
  ],
  "IsActive": false
}

Get pipeline

GET/v2/pipelines/{id}

Path parameters

id*integer (int32)

Header parameters

Response

200401403404500

Success

Body

application/json

Idinteger (int32)

Namenullable string

TypeTalentLyft.Data.Enumerators.Company.PipelineTypes (enum)

HiringPipelinePoolPipeline

Stagesnullable array of Adopto.Common.Api.Dto.Settings.StageDto (object)

IsActiveboolean

Request

JavaScriptCurlPython

const response = await fetch('/v2/pipelines/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401403404500

{
  "Id": 0,
  "Name": "text",
  "Type": "HiringPipeline",
  "Stages": [
    {
      "Id": 0,
      "Name": "text",
      "Type": "Sourced",
      "Ordinal": 0,
      "ActiveCandidates": 0,
      "DisqualifiedCandidates": 0,
      "Candidates": 0,
      "Actions": [
        {
          "Id": 0,
          "Type": "SendEmail"
        }
      ],
      "Evaluations": [
        {
          "Id": 0,
          "Type": "Scorecard"
        }
      ],
      "Integrations": [
        {
          "Type": "JobBoards"
        }
      ],
      "HasESignatureDocuments": false,
      "HasJobOfferDocuments": false
    }
  ],
  "IsActive": false
}

Update pipeline

PUT/v2/pipelines/{id}

Path parameters

id*integer (int32)

Header parameters

Body

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

Idinteger (int32)

Namenullable string

TypeTalentLyft.Data.Enumerators.Company.PipelineTypes (enum)

HiringPipelinePoolPipeline

Stagesnullable array of Adopto.Common.Api.Dto.Settings.StageDto (object)

IsActiveboolean

Response

204401403404422500

No Content

Request

JavaScriptCurlPython

const response = await fetch('/v2/pipelines/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json-patch+json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

401403404422500

{
  "Message": "text",
  "Errors": [
    {
      "Field": "text",
      "Message": "text"
    }
  ],
  "ErrorCode": 0
}

Arhive pipeline

DELETE/v2/pipelines/{id}

Path parameters

id*integer (int32)

Header parameters

Response

202401403404500

Accepted

Request

JavaScriptCurlPython

const response = await fetch('/v2/pipelines/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

401403404500

{
  "Message": "text",
  "Errors": [
    {
      "Field": "text",
      "Message": "text"
    }
  ],
  "ErrorCode": 0
}