List invites for an organization

GET /orgs/{orgId}/invites

List invites for an organization

cURL

curl --request GET \
  --url https://api.withampersand.com/v1/orgs/{orgId}/invites \
  --header 'X-Api-Key: <api-key>'

import requests

url = "https://api.withampersand.com/v1/orgs/{orgId}/invites"

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.withampersand.com/v1/orgs/{orgId}/invites', 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.withampersand.com/v1/orgs/{orgId}/invites",
  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.withampersand.com/v1/orgs/{orgId}/invites"

	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.withampersand.com/v1/orgs/{orgId}/invites")
  .header("X-Api-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.withampersand.com/v1/orgs/{orgId}/invites")

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

200

[
  {
    "id": "<string>",
    "invitedEmail": "<string>",
    "parentType": "org",
    "parentId": "<string>",
    "createTime": "2023-11-07T05:31:56Z",
    "updateTime": "2023-11-07T05:31:56Z"
  }
]

{
  "type": "urn:problem-type:exampleOrganization:exampleProblem",
  "href": "https://www.belgif.be/specification/rest/api-guide/#standardized-problem-types",
  "title": "Description of the type of problem that occurred",
  "status": 400,
  "detail": "Description of specific occurrence of the problem",
  "instance": "urn:uuid:123e4567-e89b-12d3-a456-426614174000"
}

Authorizations

APIKeyHeaderBearer

X-Api-Key · string · header · required

Path Parameters

orgId · string · required

ID of the organization.

Response

200

application/json

List of invites

id · string · required

The invite ID.

invitedEmail · string · required

The email address of the person invited.

parentType · enum<string> · required

The type of entity that the person is invited to.

Available options: org

parentId · string · required

The ID of the parent (e.g. org ID).

status · enum<string> · required

The status of the invite.

Available options: pending, accepted, revoked, expired

createTime · string<date-time> · required

The time the invite was created.

updateTime · string<date-time>

The time the invite was updated.