curl --request GET \
--url https://api.ishlabs.io/api/v1/workspaces/{workspace_id}/people \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.ishlabs.io/api/v1/workspaces/{workspace_id}/people"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.ishlabs.io/api/v1/workspaces/{workspace_id}/people', 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.ishlabs.io/api/v1/workspaces/{workspace_id}/people",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.ishlabs.io/api/v1/workspaces/{workspace_id}/people"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.ishlabs.io/api/v1/workspaces/{workspace_id}/people")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ishlabs.io/api/v1/workspaces/{workspace_id}/people")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"has_more": true,
"items": [
{
"created_at": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"owner": "self",
"updated_at": "2023-11-07T05:31:56Z",
"accessibility_profile": {},
"archived_at": "2023-11-07T05:31:56Z",
"avatar_url": "<string>",
"bio": "<string>",
"city": "<string>",
"country": "<string>",
"date_of_birth": "2023-12-25",
"education_level": "less_than_secondary",
"employment_status": "employed_full_time",
"external_id": "<string>",
"gender": "male",
"generation_job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"household": "single",
"income_level": "lower",
"interests": [
"<string>"
],
"locale_type": "urban",
"occupation": "<string>",
"occupation_code": "<string>",
"type": "ai",
"workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"next_cursor": "<string>"
}{
"detail": "<string>",
"request_id": "<string>",
"docs_url": "<string>"
}{
"detail": "<string>",
"request_id": "<string>",
"docs_url": "<string>"
}{
"detail": "<string>",
"request_id": "<string>",
"docs_url": "<string>"
}{
"detail": "<string>",
"error": "<string>",
"error_code": "<string>",
"errors": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"allowed_values": [
"<unknown>"
],
"input": "<string>"
}
],
"retryable": true,
"status": 123,
"suggestions": [
"<string>"
]
}{
"detail": "<string>",
"request_id": "<string>",
"docs_url": "<string>"
}List People
List the people you can open a session for, newest first.
Two kinds of person are reachable: the ones your workspace owns, and the
ones published in the shared ish library. Both are usable in a session, and
each row’s owner says which it is. People that other workspaces have
published are deliberately NOT listed: you could not open a session for
them, and listing what you cannot use is worse than not listing it.
Keyset-paginated: page forward with after set to the previous response’s
next_cursor, and stop when has_more is false. For anything beyond a name
match, use the search endpoint.
curl --request GET \
--url https://api.ishlabs.io/api/v1/workspaces/{workspace_id}/people \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.ishlabs.io/api/v1/workspaces/{workspace_id}/people"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.ishlabs.io/api/v1/workspaces/{workspace_id}/people', 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.ishlabs.io/api/v1/workspaces/{workspace_id}/people",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.ishlabs.io/api/v1/workspaces/{workspace_id}/people"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.ishlabs.io/api/v1/workspaces/{workspace_id}/people")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ishlabs.io/api/v1/workspaces/{workspace_id}/people")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"has_more": true,
"items": [
{
"created_at": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"owner": "self",
"updated_at": "2023-11-07T05:31:56Z",
"accessibility_profile": {},
"archived_at": "2023-11-07T05:31:56Z",
"avatar_url": "<string>",
"bio": "<string>",
"city": "<string>",
"country": "<string>",
"date_of_birth": "2023-12-25",
"education_level": "less_than_secondary",
"employment_status": "employed_full_time",
"external_id": "<string>",
"gender": "male",
"generation_job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"household": "single",
"income_level": "lower",
"interests": [
"<string>"
],
"locale_type": "urban",
"occupation": "<string>",
"occupation_code": "<string>",
"type": "ai",
"workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"next_cursor": "<string>"
}{
"detail": "<string>",
"request_id": "<string>",
"docs_url": "<string>"
}{
"detail": "<string>",
"request_id": "<string>",
"docs_url": "<string>"
}{
"detail": "<string>",
"request_id": "<string>",
"docs_url": "<string>"
}{
"detail": "<string>",
"error": "<string>",
"error_code": "<string>",
"errors": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"allowed_values": [
"<unknown>"
],
"input": "<string>"
}
],
"retryable": true,
"status": 123,
"suggestions": [
"<string>"
]
}{
"detail": "<string>",
"request_id": "<string>",
"docs_url": "<string>"
}Authorizations
Workspace API key as a bearer token: Authorization: Bearer ish_sk_live_.... Keys are workspace-scoped machine principals minted in Settings > Developers (shown once at mint). Scopes: sessions:run (create a session, submit turns, close), sessions:read (read the session and its decision trace), environments:read and environments:write (manage the workspace's registered environments), tasks:read and tasks:write (manage the workspace's registered tasks), people:read and people:write (the people the workspace can run a session for), and usage:read (the workspace's own consumption, spend limits and rate-limit budgets). A key is minted with sessions:run, sessions:read, and tasks:read by default; every other scope must be requested, people:read and usage:read included. An ish user access token also works on the same header for personal scripts.
Path Parameters
Query Parameters
Restrict to one owner: self for people this workspace owns, platform for the shared ish library. Omit it to get both, which is exactly the set you can open a session for.
^(self|platform)$Case-insensitive substring match on the person's name.
200Look a person up by the id YOUR system gave them. Exact match, and at most one person can carry it, so a hit is a one-item page and a miss is an empty one. This is the lookup, and it lives here rather than on a path so that a missing external id is an empty result rather than a 404 you have to branch on.
255Restrict to the people one generation job produced. This is how a job's results are collected: poll the job, then list by its id. Reads its own writes.
false (the default) lists live people; true lists the archive instead. The two sets are disjoint, so this chooses which one you are looking at rather than widening the list.
Opaque keyset cursor from a prior page's next_cursor.
1 <= x <= 100Response
Successful Response
A keyset-paginated page of people.
Ordered created_at DESC, id DESC, the same order and the same envelope
as the session list, so one pagination helper in an SDK drives both.