GetOrganization

curl --request POST \
  --url https://edge.sterndesk.com/rpc/rpc.v1.OrganizationService/GetOrganization \
  --header 'Authorization: Bearer <token>' \
  --header 'Connect-Protocol-Version: <connect-protocol-version>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "organizationId": "<string>"
}
'

import requests

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

payload = { "organizationId": "<string>" }
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({organizationId: '<string>'})
};

fetch('https://edge.sterndesk.com/rpc/rpc.v1.OrganizationService/GetOrganization', 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/GetOrganization",
  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([
    'organizationId' => '<string>'
  ]),
  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/GetOrganization"

	payload := strings.NewReader("{\n  \"organizationId\": \"<string>\"\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/GetOrganization")
  .header("Connect-Protocol-Version", "<connect-protocol-version>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"organizationId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"organizationId\": \"<string>\"\n}"

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

{
  "id": "<string>",
  "name": "<string>",
  "slug": "<string>",
  "isSetupBasic": true,
  "allJobPostingFilterValues": [
    {
      "valueId": "<string>",
      "filterId": "<string>",
      "filterSlot": "<string>",
      "filterName": "<string>",
      "stringValue": "<string>",
      "totalJobPostings": "<string>"
    }
  ],
  "allJobPostingFilters": [
    {
      "id": "<string>",
      "organizationId": "<string>",
      "slot": "<string>",
      "name": "<string>"
    }
  ],
  "jobPostingEnabledLanguages": [
    {
      "id": "<string>",
      "organizationId": "<string>",
      "codeIso6393": "<string>",
      "totalJobPostings": "<string>"
    }
  ],
  "totalCrewProfiles": "<string>",
  "totalJobPostings": "<string>",
  "totalPinnedJobPostings": "<string>",
  "maxPinnedJobPostings": "<string>",
  "totalActiveCrewProfiles": "<string>",
  "recentlyDeletedCrewProfiles": "<string>",
  "totalOpenJobPostings": "<string>",
  "totalClosedJobPostings": "<string>",
  "totalProposals": "<string>"
}

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

POST

rpc

rpc.v1.OrganizationService

GetOrganization

curl --request POST \
  --url https://edge.sterndesk.com/rpc/rpc.v1.OrganizationService/GetOrganization \
  --header 'Authorization: Bearer <token>' \
  --header 'Connect-Protocol-Version: <connect-protocol-version>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "organizationId": "<string>"
}
'

import requests

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

payload = { "organizationId": "<string>" }
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({organizationId: '<string>'})
};

fetch('https://edge.sterndesk.com/rpc/rpc.v1.OrganizationService/GetOrganization', 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/GetOrganization",
  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([
    'organizationId' => '<string>'
  ]),
  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/GetOrganization"

	payload := strings.NewReader("{\n  \"organizationId\": \"<string>\"\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/GetOrganization")
  .header("Connect-Protocol-Version", "<connect-protocol-version>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"organizationId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"organizationId\": \"<string>\"\n}"

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

{
  "id": "<string>",
  "name": "<string>",
  "slug": "<string>",
  "isSetupBasic": true,
  "allJobPostingFilterValues": [
    {
      "valueId": "<string>",
      "filterId": "<string>",
      "filterSlot": "<string>",
      "filterName": "<string>",
      "stringValue": "<string>",
      "totalJobPostings": "<string>"
    }
  ],
  "allJobPostingFilters": [
    {
      "id": "<string>",
      "organizationId": "<string>",
      "slot": "<string>",
      "name": "<string>"
    }
  ],
  "jobPostingEnabledLanguages": [
    {
      "id": "<string>",
      "organizationId": "<string>",
      "codeIso6393": "<string>",
      "totalJobPostings": "<string>"
    }
  ],
  "totalCrewProfiles": "<string>",
  "totalJobPostings": "<string>",
  "totalPinnedJobPostings": "<string>",
  "maxPinnedJobPostings": "<string>",
  "totalActiveCrewProfiles": "<string>",
  "recentlyDeletedCrewProfiles": "<string>",
  "totalOpenJobPostings": "<string>",
  "totalClosedJobPostings": "<string>",
  "totalProposals": "<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 to get organization info

organizationId

string

id of the organization to request information about

Response

Success

response with organization info

string

id of the organization

name

string

name of the organization

slug

string | null

slug of the organization

isSetupBasic

boolean

wether or not basic setup is done

allJobPostingFilterValues

JobPostingFilterValue · object[]

all filter values (and filters they belong to)

Show child attributes

allJobPostingFilters

JobPostingFilter · object[]

all filters for the organization

Show child attributes

jobPostingEnabledLanguages

JobPostingEnabledLanguage · object[]

the languags that are enabled for the organization to crated job postings for

Show child attributes

totalCrewProfiles

string<int64>

total number of crew profiles the organization has

totalJobPostings

string<int64>

total nr of job postings the organization has

totalPinnedJobPostings

string<int64>

total nr of pinned job postings the organization has

maxPinnedJobPostings

string<int64>

maximum nr of pinned job postings the organization can have

totalActiveCrewProfiles

string<int64>

total of active crew profiles

recentlyDeletedCrewProfiles

string<int64>

total archived crew profiles

totalOpenJobPostings

string<int64>

total of open job postings the organisation has

totalClosedJobPostings

string<int64>

total of closed job postings the organisation has

totalProposals

string<int64>

total nr of proposals the organization has

Overview

Endpoints

GetOrganization

Authorizations

Headers

Body

Response