cURL
curl --request GET \
--url https://api.nekt.ai/api/v1/workspace/invitations/ \
--header 'x-api-key: <api-key>'import requests
url = "https://api.nekt.ai/api/v1/workspace/invitations/"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.nekt.ai/api/v1/workspace/invitations/', 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.nekt.ai/api/v1/workspace/invitations/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$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.nekt.ai/api/v1/workspace/invitations/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
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.nekt.ai/api/v1/workspace/invitations/")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nekt.ai/api/v1/workspace/invitations/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"first_name": "<string>",
"last_name": "<string>",
"email": "jsmith@example.com",
"organization_role": "<string>",
"functional_area": "data_analytics",
"other_functional_area": "<string>",
"sent_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"accepted_at": "2023-11-07T05:31:56Z",
"revoked_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"created_by": 123,
"user": 123,
"workspace_role": "<string>",
"shared": true
}
]Workspace invitations
List Workspace Invitations
The pending invitees waiting in your current workspace.
GET
/
api
/
v1
/
workspace
/
invitations
/
cURL
curl --request GET \
--url https://api.nekt.ai/api/v1/workspace/invitations/ \
--header 'x-api-key: <api-key>'import requests
url = "https://api.nekt.ai/api/v1/workspace/invitations/"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.nekt.ai/api/v1/workspace/invitations/', 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.nekt.ai/api/v1/workspace/invitations/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$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.nekt.ai/api/v1/workspace/invitations/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
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.nekt.ai/api/v1/workspace/invitations/")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nekt.ai/api/v1/workspace/invitations/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"first_name": "<string>",
"last_name": "<string>",
"email": "jsmith@example.com",
"organization_role": "<string>",
"functional_area": "data_analytics",
"other_functional_area": "<string>",
"sent_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"accepted_at": "2023-11-07T05:31:56Z",
"revoked_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"created_by": 123,
"user": 123,
"workspace_role": "<string>",
"shared": true
}
]Returns the organization’s outstanding invitations whose invitee already has a place in the API key’s workspace, each with the role waiting for them there. Use it to see who is pending in a workspace without needing organization-level rights.
Response
An array of workspace invitation objects, newest first. This endpoint is not paginated.[
{
"id": "c1f0a9d4-5b62-4e18-9a73-2d8e4f6b0c51",
"email": "analyst@example.com",
"first_name": "",
"last_name": "",
"organization_role": "member",
"workspace_role": "member",
"shared": false,
"created_by": 12,
"user": 48,
"sent_at": "2026-11-16T10:14:02Z",
"expires_at": "2026-11-23T10:14:02Z",
"accepted_at": null,
"revoked_at": null,
"created_at": "2026-11-16T10:14:02Z"
}
]
| Field | Description |
|---|---|
organization_role | The role in the organization the invitation grants. |
workspace_role | The role waiting for the invitee in this workspace. |
shared | true when the invitation reaches beyond this workspace: it was issued elsewhere (by the organization or another workspace), or the invitee is in another workspace too. A shared invitation can only be revoked from the organization’s invitations. |
created_by and user are ids; pass expand[]=created_by or expand[]=user to get the objects.
Unlike the organization’s list, there is no workspace field: the workspace that issued the invitation may be one you cannot see.
Example
curl --request GET \
--url "https://api.nekt.ai/api/v1/workspace/invitations/?expand[]=user" \
--header "x-api-key: YOUR_API_KEY"
Authentication
This endpoint requires an API key created by a workspace admin of the key’s workspace. Organization owners and admins are admins of every workspace.Related
- Invite to Workspace: add someone to this workspace.
- Revoke a Workspace Invitation: cancel one that stays inside this workspace.
- List Invitations: every outstanding invitation in the organization.
Response
200 - application/json
data_analytics- Data & Analyticssales- Salescustomer_support- Customer Supportoperations- Operationsmarketing- Marketingfinance- Financeproduct_development- Product Developmentgrowth- Growthexecutive_leadership- Executive Leadershipother- Other
Available options:
data_analytics, sales, customer_support, operations, marketing, finance, product_development, growth, executive_leadership, other Was this page helpful?