Pipelines

Retrieve all pipelines

GET/v2/pipelines
Query parameters
Header parameters
Response

Success

Body
Idinteger (int32)
Namenullable string
TypeTalentLyft.Data.Enumerators.Company.PipelineTypes (enum)
HiringPipelinePoolPipeline
Stagesnullable array of Adopto.Common.Api.Dto.Settings.StageDto (object)
IsActiveboolean
Request
const response = await fetch('/v2/pipelines', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
[
  {
    "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
Idinteger (int32)
Namenullable string
TypeTalentLyft.Data.Enumerators.Company.PipelineTypes (enum)
HiringPipelinePoolPipeline
Stagesnullable array of Adopto.Common.Api.Dto.Settings.StageDto (object)
IsActiveboolean
Response

Created

Body
Idinteger (int32)
Namenullable string
TypeTalentLyft.Data.Enumerators.Company.PipelineTypes (enum)
HiringPipelinePoolPipeline
Stagesnullable array of Adopto.Common.Api.Dto.Settings.StageDto (object)
IsActiveboolean
Request
const response = await fetch('/v2/pipelines', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json-patch+json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();
Response
{
  "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

Success

Body
Idinteger (int32)
Namenullable string
TypeTalentLyft.Data.Enumerators.Company.PipelineTypes (enum)
HiringPipelinePoolPipeline
Stagesnullable array of Adopto.Common.Api.Dto.Settings.StageDto (object)
IsActiveboolean
Request
const response = await fetch('/v2/pipelines/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "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
Idinteger (int32)
Namenullable string
TypeTalentLyft.Data.Enumerators.Company.PipelineTypes (enum)
HiringPipelinePoolPipeline
Stagesnullable array of Adopto.Common.Api.Dto.Settings.StageDto (object)
IsActiveboolean
Response

No Content

Request
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
{
  "Message": "text",
  "Errors": [
    {
      "Field": "text",
      "Message": "text"
    }
  ],
  "ErrorCode": 0
}

Arhive pipeline

DELETE/v2/pipelines/{id}
Path parameters
id*integer (int32)
Header parameters
Response

Accepted

Request
const response = await fetch('/v2/pipelines/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();
Response
{
  "Message": "text",
  "Errors": [
    {
      "Field": "text",
      "Message": "text"
    }
  ],
  "ErrorCode": 0
}