Retrieve a list of organizations

curl --request GET \
  --url http://localhost:{port}/organizations \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('http://localhost:{port}/organizations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "62437",
  CURLOPT_URL => "http://localhost:{port}/organizations",
  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 := "http://localhost:{port}/organizations"

	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))

}

require 'uri'
require 'net/http'

url = URI("http://localhost:{port}/organizations")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

[
  {
    "id": "d4add56e-c345-4ac9-b392-7a890a60559a",
    "name": "Delay Technologies",
    "short_name": "Delay",
    "logo_url": "https://d3lay.com/logo.png",
    "website_url": "https://d3lay.com",
    "workspace_id": "0c47fb41-54d8-4e9e-942f-d9d5af6eaeb3",
    "created_at": "2023-05-06T00:00:00Z",
    "updated_at": "2023-05-06T00:00:00Z",
    "created_by": "98d91cd7-860d-4869-937a-5af32eff2f4a",
    "updated_by": "98d91cd7-860d-4869-937a-5af32eff2f4a"
  },
  {
    "id": "e513d2c8-319e-4bc3-898b-3933ab39b452",
    "name": "Bite Investments",
    "short_name": "Bite",
    "logo_url": "https://biteinvestments.com/logo.png",
    "website_url": "https://biteinvestments.com",
    "workspace_id": "016e7cb4-5f16-4c61-9466-d0d8bf018df1",
    "created_at": "2023-05-07T00:00:00Z",
    "updated_at": "2023-05-07T00:00:00Z",
    "created_by": "98d91cd7-860d-4869-937a-5af32eff2f4a",
    "updated_by": "98d91cd7-860d-4869-937a-5af32eff2f4a"
  },
  {
    "id": "d4add56e-c345-4ac9-b392-7a890a60559a",
    "name": "Microsoft Corporation",
    "short_name": "Microsoft",
    "logo_url": "https://microsoft.com/logo.png",
    "website_url": "https://microsoft.com",
    "workspace_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "created_at": "2023-05-07T00:00:00Z",
    "updated_at": "2023-05-07T00:00:00Z",
    "created_by": "98d91cd7-860d-4869-937a-5af32eff2f4a",
    "updated_by": "98d91cd7-860d-4869-937a-5af32eff2f4a"
  }
]

GET

organizations

Retrieve a list of organizations

curl --request GET \
  --url http://localhost:{port}/organizations \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('http://localhost:{port}/organizations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "62437",
  CURLOPT_URL => "http://localhost:{port}/organizations",
  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 := "http://localhost:{port}/organizations"

	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))

}

require 'uri'
require 'net/http'

url = URI("http://localhost:{port}/organizations")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

[
  {
    "id": "d4add56e-c345-4ac9-b392-7a890a60559a",
    "name": "Delay Technologies",
    "short_name": "Delay",
    "logo_url": "https://d3lay.com/logo.png",
    "website_url": "https://d3lay.com",
    "workspace_id": "0c47fb41-54d8-4e9e-942f-d9d5af6eaeb3",
    "created_at": "2023-05-06T00:00:00Z",
    "updated_at": "2023-05-06T00:00:00Z",
    "created_by": "98d91cd7-860d-4869-937a-5af32eff2f4a",
    "updated_by": "98d91cd7-860d-4869-937a-5af32eff2f4a"
  },
  {
    "id": "e513d2c8-319e-4bc3-898b-3933ab39b452",
    "name": "Bite Investments",
    "short_name": "Bite",
    "logo_url": "https://biteinvestments.com/logo.png",
    "website_url": "https://biteinvestments.com",
    "workspace_id": "016e7cb4-5f16-4c61-9466-d0d8bf018df1",
    "created_at": "2023-05-07T00:00:00Z",
    "updated_at": "2023-05-07T00:00:00Z",
    "created_by": "98d91cd7-860d-4869-937a-5af32eff2f4a",
    "updated_by": "98d91cd7-860d-4869-937a-5af32eff2f4a"
  },
  {
    "id": "d4add56e-c345-4ac9-b392-7a890a60559a",
    "name": "Microsoft Corporation",
    "short_name": "Microsoft",
    "logo_url": "https://microsoft.com/logo.png",
    "website_url": "https://microsoft.com",
    "workspace_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "created_at": "2023-05-07T00:00:00Z",
    "updated_at": "2023-05-07T00:00:00Z",
    "created_by": "98d91cd7-860d-4869-937a-5af32eff2f4a",
    "updated_by": "98d91cd7-860d-4869-937a-5af32eff2f4a"
  }
]

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-API-Version

enum<string>

default:v1

Your API version

Available options:

v1

Content-Type

enum<string>

Available options:

application/json,

application/xml,

application/x-www-form-urlencoded,

application/octet-stream,

application/pdf,

text/plain,

text/html,

multipart/form-data

Query Parameters

sort_by

string

The field to sort by.

sort_order

enum<string>

Order of sorting (asc or desc) Sort order:

asc - Ascending, from A to Z
desc - Descending, from Z to A

Available options:

asc,

desc

string

Filter data by its id, require metadata permissions, REQUIRE metadata permissions

created_by

string

Filter data by the user who created them, REQUIRE metadata permissions

updated_by

string

Filter data by the user who last updated them, REQUIRE metadata permissions

workspace_id

string

Filter data by workspace ID.

created_at_from

string<date-time>

Filter data that were created after this date.

created_at_to

string<date-time>

Filter data that were created before this date.

updated_at_from

string<date-time>

Filter data that were updated after this date.

updated_at_to

string<date-time>

Filter data that were updated before this date.

string

Fuzzy match data by id, email, name or description.

page

integer

The page number to retrieve.

Required range: x >= 1

page_size

integer

The number of items to retrieve per page.

Required range: 1 <= x <= 100

Response

Success

string

required

name

string

required

short_name

string

required

logo_url

string

required

website_url

string

required

created_at

string<date-time>

required

updated_at

string<date-time>

required

workspace_id

string<uuid>

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

created_by

string<uuid>

REQUIRE metadata permissions

Example:

"98d91cd7-860d-4869-937a-5af32eff2f4a"

updated_by

string<uuid>

REQUIRE metadata permissions

Example:

"98d91cd7-860d-4869-937a-5af32eff2f4a"