curl --request POST \
--url https://api.example.com/api/directory/resources.list \
--header 'Content-Type: application/json' \
--data '
{
"kind_id": "872815618512410358",
"at_date": "2019-11-11",
"attributes": [
"<string>"
],
"with_teams": false,
"with_relations": false,
"with_total_count": false,
"counting_mode": "strict",
"filters": [
{
"key": "resource.ids",
"value": [
"872815618512410358"
]
}
],
"orders": [
{
"key": "resource.attribute",
"direction": "asc",
"attribute": "<string>"
}
]
}
'import requests
url = "https://api.example.com/api/directory/resources.list"
payload = {
"kind_id": "872815618512410358",
"at_date": "2019-11-11",
"attributes": ["<string>"],
"with_teams": False,
"with_relations": False,
"with_total_count": False,
"counting_mode": "strict",
"filters": [
{
"key": "resource.ids",
"value": ["872815618512410358"]
}
],
"orders": [
{
"key": "resource.attribute",
"direction": "asc",
"attribute": "<string>"
}
]
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
kind_id: '872815618512410358',
at_date: '2019-11-11',
attributes: ['<string>'],
with_teams: false,
with_relations: false,
with_total_count: false,
counting_mode: 'strict',
filters: [{key: 'resource.ids', value: ['872815618512410358']}],
orders: [{key: 'resource.attribute', direction: 'asc', attribute: '<string>'}]
})
};
fetch('https://api.example.com/api/directory/resources.list', 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://api.example.com/api/directory/resources.list",
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([
'kind_id' => '872815618512410358',
'at_date' => '2019-11-11',
'attributes' => [
'<string>'
],
'with_teams' => false,
'with_relations' => false,
'with_total_count' => false,
'counting_mode' => 'strict',
'filters' => [
[
'key' => 'resource.ids',
'value' => [
'872815618512410358'
]
]
],
'orders' => [
[
'key' => 'resource.attribute',
'direction' => 'asc',
'attribute' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"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://api.example.com/api/directory/resources.list"
payload := strings.NewReader("{\n \"kind_id\": \"872815618512410358\",\n \"at_date\": \"2019-11-11\",\n \"attributes\": [\n \"<string>\"\n ],\n \"with_teams\": false,\n \"with_relations\": false,\n \"with_total_count\": false,\n \"counting_mode\": \"strict\",\n \"filters\": [\n {\n \"key\": \"resource.ids\",\n \"value\": [\n \"872815618512410358\"\n ]\n }\n ],\n \"orders\": [\n {\n \"key\": \"resource.attribute\",\n \"direction\": \"asc\",\n \"attribute\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
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://api.example.com/api/directory/resources.list")
.header("Content-Type", "application/json")
.body("{\n \"kind_id\": \"872815618512410358\",\n \"at_date\": \"2019-11-11\",\n \"attributes\": [\n \"<string>\"\n ],\n \"with_teams\": false,\n \"with_relations\": false,\n \"with_total_count\": false,\n \"counting_mode\": \"strict\",\n \"filters\": [\n {\n \"key\": \"resource.ids\",\n \"value\": [\n \"872815618512410358\"\n ]\n }\n ],\n \"orders\": [\n {\n \"key\": \"resource.attribute\",\n \"direction\": \"asc\",\n \"attribute\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/directory/resources.list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"kind_id\": \"872815618512410358\",\n \"at_date\": \"2019-11-11\",\n \"attributes\": [\n \"<string>\"\n ],\n \"with_teams\": false,\n \"with_relations\": false,\n \"with_total_count\": false,\n \"counting_mode\": \"strict\",\n \"filters\": [\n {\n \"key\": \"resource.ids\",\n \"value\": [\n \"872815618512410358\"\n ]\n }\n ],\n \"orders\": [\n {\n \"key\": \"resource.attribute\",\n \"direction\": \"asc\",\n \"attribute\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "872815618512410358",
"kind_id": "872815618512410358",
"label": "<string>",
"short_label": "<string>",
"sort_label": "<string>",
"picture": {
"shape": "round",
"initial": "<string>",
"url": "<string>"
},
"attributes": {},
"teams": [
{
"id": "872815618512410358",
"head": true,
"name": "<string>"
}
],
"relations": [
{
"relation_type_id": "872815618512410358",
"related_to": "872815618512410358",
"related_by": [
"872815618512410358"
]
}
]
}
],
"next_token": "<string>",
"total_count": 123,
"total_count_approximate": true
}List
Retrieves all resources of a specific kind, including those with no (or only past) sector contracts. Returns associated details related to that kind. Use the ‘resource.team’ filter to narrow down the search by contract period (e.g. only currently employed).
curl --request POST \
--url https://api.example.com/api/directory/resources.list \
--header 'Content-Type: application/json' \
--data '
{
"kind_id": "872815618512410358",
"at_date": "2019-11-11",
"attributes": [
"<string>"
],
"with_teams": false,
"with_relations": false,
"with_total_count": false,
"counting_mode": "strict",
"filters": [
{
"key": "resource.ids",
"value": [
"872815618512410358"
]
}
],
"orders": [
{
"key": "resource.attribute",
"direction": "asc",
"attribute": "<string>"
}
]
}
'import requests
url = "https://api.example.com/api/directory/resources.list"
payload = {
"kind_id": "872815618512410358",
"at_date": "2019-11-11",
"attributes": ["<string>"],
"with_teams": False,
"with_relations": False,
"with_total_count": False,
"counting_mode": "strict",
"filters": [
{
"key": "resource.ids",
"value": ["872815618512410358"]
}
],
"orders": [
{
"key": "resource.attribute",
"direction": "asc",
"attribute": "<string>"
}
]
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
kind_id: '872815618512410358',
at_date: '2019-11-11',
attributes: ['<string>'],
with_teams: false,
with_relations: false,
with_total_count: false,
counting_mode: 'strict',
filters: [{key: 'resource.ids', value: ['872815618512410358']}],
orders: [{key: 'resource.attribute', direction: 'asc', attribute: '<string>'}]
})
};
fetch('https://api.example.com/api/directory/resources.list', 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://api.example.com/api/directory/resources.list",
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([
'kind_id' => '872815618512410358',
'at_date' => '2019-11-11',
'attributes' => [
'<string>'
],
'with_teams' => false,
'with_relations' => false,
'with_total_count' => false,
'counting_mode' => 'strict',
'filters' => [
[
'key' => 'resource.ids',
'value' => [
'872815618512410358'
]
]
],
'orders' => [
[
'key' => 'resource.attribute',
'direction' => 'asc',
'attribute' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"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://api.example.com/api/directory/resources.list"
payload := strings.NewReader("{\n \"kind_id\": \"872815618512410358\",\n \"at_date\": \"2019-11-11\",\n \"attributes\": [\n \"<string>\"\n ],\n \"with_teams\": false,\n \"with_relations\": false,\n \"with_total_count\": false,\n \"counting_mode\": \"strict\",\n \"filters\": [\n {\n \"key\": \"resource.ids\",\n \"value\": [\n \"872815618512410358\"\n ]\n }\n ],\n \"orders\": [\n {\n \"key\": \"resource.attribute\",\n \"direction\": \"asc\",\n \"attribute\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
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://api.example.com/api/directory/resources.list")
.header("Content-Type", "application/json")
.body("{\n \"kind_id\": \"872815618512410358\",\n \"at_date\": \"2019-11-11\",\n \"attributes\": [\n \"<string>\"\n ],\n \"with_teams\": false,\n \"with_relations\": false,\n \"with_total_count\": false,\n \"counting_mode\": \"strict\",\n \"filters\": [\n {\n \"key\": \"resource.ids\",\n \"value\": [\n \"872815618512410358\"\n ]\n }\n ],\n \"orders\": [\n {\n \"key\": \"resource.attribute\",\n \"direction\": \"asc\",\n \"attribute\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/directory/resources.list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"kind_id\": \"872815618512410358\",\n \"at_date\": \"2019-11-11\",\n \"attributes\": [\n \"<string>\"\n ],\n \"with_teams\": false,\n \"with_relations\": false,\n \"with_total_count\": false,\n \"counting_mode\": \"strict\",\n \"filters\": [\n {\n \"key\": \"resource.ids\",\n \"value\": [\n \"872815618512410358\"\n ]\n }\n ],\n \"orders\": [\n {\n \"key\": \"resource.attribute\",\n \"direction\": \"asc\",\n \"attribute\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "872815618512410358",
"kind_id": "872815618512410358",
"label": "<string>",
"short_label": "<string>",
"sort_label": "<string>",
"picture": {
"shape": "round",
"initial": "<string>",
"url": "<string>"
},
"attributes": {},
"teams": [
{
"id": "872815618512410358",
"head": true,
"name": "<string>"
}
],
"relations": [
{
"relation_type_id": "872815618512410358",
"related_to": "872815618512410358",
"related_by": [
"872815618512410358"
]
}
]
}
],
"next_token": "<string>",
"total_count": 123,
"total_count_approximate": true
}Body
Only the "employee" kind is available at the moment.
"872815618512410358"
If you do not specify a date, today's date will be used.
"2019-11-11"
Several filters can be used to narrow down the search (except for activity rate). Correct filter types should be used based on the data type of the attribute. The 'api/directory/kinds.show' endpoint gives you information about attribute types and whether you can filter or order them.
Will give additional information about the team they are assigned to at the date provided.
strict, approximate "strict"
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
- Option 10
- Option 11
- Option 12
- Option 13
- Option 14
- Option 15
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
Show child attributes
Show child attributes
Total number of resources matching filters in the request; only present if parameter "with_total_count" is set to "true".
TRUE if the returned number of resources is exact, FALSE if it is only an approximation; only present if parameter "with_total_count" is set to "true".