GetPipeline

curl --request POST \
  --url https://edge.sterndesk.com/rpc/rpc.v1.OrganizationService/GetPipeline \
  --header 'Authorization: Bearer <token>' \
  --header 'Connect-Protocol-Version: <connect-protocol-version>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pipelineId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://edge.sterndesk.com/rpc/rpc.v1.OrganizationService/GetPipeline"

payload = { "pipelineId": "3c90c3cc-0d44-4b50-8888-8dd25736052a" }
headers = {
    "Connect-Protocol-Version": "<connect-protocol-version>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Connect-Protocol-Version': '<connect-protocol-version>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({pipelineId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'})
};

fetch('https://edge.sterndesk.com/rpc/rpc.v1.OrganizationService/GetPipeline', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://edge.sterndesk.com/rpc/rpc.v1.OrganizationService/GetPipeline",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'pipelineId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Connect-Protocol-Version: <connect-protocol-version>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://edge.sterndesk.com/rpc/rpc.v1.OrganizationService/GetPipeline"

	payload := strings.NewReader("{\n  \"pipelineId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Connect-Protocol-Version", "<connect-protocol-version>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://edge.sterndesk.com/rpc/rpc.v1.OrganizationService/GetPipeline")
  .header("Connect-Protocol-Version", "<connect-protocol-version>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"pipelineId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://edge.sterndesk.com/rpc/rpc.v1.OrganizationService/GetPipeline")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Connect-Protocol-Version"] = '<connect-protocol-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"pipelineId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

response = http.request(request)
puts response.read_body

{
  "pipelineId": "<string>",
  "name": "<string>",
  "isDefault": true,
  "totalJobPostings": "<string>"
}

{
  "code": "not_found",
  "message": "<string>",
  "details": [
    {
      "type": "<string>",
      "value": "<string>",
      "debug": {}
    }
  ]
}

POST

rpc

rpc.v1.OrganizationService

GetPipeline

curl --request POST \
  --url https://edge.sterndesk.com/rpc/rpc.v1.OrganizationService/GetPipeline \
  --header 'Authorization: Bearer <token>' \
  --header 'Connect-Protocol-Version: <connect-protocol-version>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pipelineId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://edge.sterndesk.com/rpc/rpc.v1.OrganizationService/GetPipeline"

payload = { "pipelineId": "3c90c3cc-0d44-4b50-8888-8dd25736052a" }
headers = {
    "Connect-Protocol-Version": "<connect-protocol-version>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Connect-Protocol-Version': '<connect-protocol-version>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({pipelineId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'})
};

fetch('https://edge.sterndesk.com/rpc/rpc.v1.OrganizationService/GetPipeline', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://edge.sterndesk.com/rpc/rpc.v1.OrganizationService/GetPipeline",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'pipelineId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Connect-Protocol-Version: <connect-protocol-version>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://edge.sterndesk.com/rpc/rpc.v1.OrganizationService/GetPipeline"

	payload := strings.NewReader("{\n  \"pipelineId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Connect-Protocol-Version", "<connect-protocol-version>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://edge.sterndesk.com/rpc/rpc.v1.OrganizationService/GetPipeline")
  .header("Connect-Protocol-Version", "<connect-protocol-version>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"pipelineId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://edge.sterndesk.com/rpc/rpc.v1.OrganizationService/GetPipeline")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Connect-Protocol-Version"] = '<connect-protocol-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"pipelineId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

response = http.request(request)
puts response.read_body

{
  "pipelineId": "<string>",
  "name": "<string>",
  "isDefault": true,
  "totalJobPostings": "<string>"
}

{
  "code": "not_found",
  "message": "<string>",
  "details": [
    {
      "type": "<string>",
      "value": "<string>",
      "debug": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

Personal API key, sent as Authorization: Bearer <key>.

Headers

Connect-Protocol-Version

number

required

Define the version of the Connect protocol

Example:

1

Connect-Timeout-Ms

number

Define the timeout, in ms

Example:

1000

Body

application/json

Request for getting a single pipeline

pipelineId

string<uuid>

ID of the pipeline to retrieve

Response

Success

Response for a single pipeline

pipelineId

string

ID of the pipeline

name

string

Name of the pipeline

isDefault

boolean

Whether the pipeline is default

totalJobPostings

string<int64>

A total number of job postings by pipeline id

Overview

Endpoints

GetPipeline

Authorizations

Headers

Body

Response