List organisations

GET

organisations

List organisations

curl --request GET \
  --url https://api.hyperline.co/v1/organisations \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.hyperline.co/v1/organisations', 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.hyperline.co/v1/organisations",
  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.hyperline.co/v1/organisations"

	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("https://api.hyperline.co/v1/organisations")

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

{
  "data": [
    {
      "id": "cus_0noDeAEU22FgA4",
      "name": "Acme Group",
      "currency": "EUR",
      "country": "FR",
      "invoice_schedule": "month",
      "next_invoice_at": "2024-04-01T00:00:00Z",
      "child_customer_ids": [
        "cus_Typ0px2W0aiEtl"
      ],
      "updated_at": "2026-09-15T00:00:00Z"
    }
  ],
  "next_cursor": null,
  "has_more": false,
  "total": 1
}

{
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

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

Query Parameters

limit

number

default:50

Maximum number of items to return (1-100).

Required range: x <= 100

Example:

50

cursor

string

Opaque cursor returned in the previous response's next_cursor. Omit to fetch the first page.

include_total

default:false

Set to true to include total in the response.

Example:

false

order

enum<string>

default:desc

Sort direction.

Available options:

asc,

desc

Example:

"desc"

sort

enum<string>

Field used to sort the results.

Available options:

created_at,

updated_at

created_at

string<date-time>

created_at__not

string<date-time>

created_at__equals

string<date-time>

created_at__lt

string<date-time>

created_at__lte

string<date-time>

created_at__gt

string<date-time>

created_at__gte

string<date-time>

updated_at

string<date-time>

updated_at__not

string<date-time>

updated_at__equals

string<date-time>

updated_at__lt

string<date-time>

updated_at__lte

string<date-time>

updated_at__gt

string<date-time>

updated_at__gte

string<date-time>

Response

data

object[]

required

List of Organisation.

Show child attributes

next_cursor

string | null

required

Cursor to fetch the next page. null when there are no more items.

Example:

null

has_more

boolean

required

Whether more items are available after this page.

Example:

false

total

number

Total number of items matching the filters. Only present when include_total=true was passed.

Example:

1

⌘I

List organisations

curl --request GET \
  --url https://api.hyperline.co/v1/organisations \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.hyperline.co/v1/organisations', 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.hyperline.co/v1/organisations",
  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.hyperline.co/v1/organisations"

	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("https://api.hyperline.co/v1/organisations")

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

{
  "data": [
    {
      "id": "cus_0noDeAEU22FgA4",
      "name": "Acme Group",
      "currency": "EUR",
      "country": "FR",
      "invoice_schedule": "month",
      "next_invoice_at": "2024-04-01T00:00:00Z",
      "child_customer_ids": [
        "cus_Typ0px2W0aiEtl"
      ],
      "updated_at": "2026-09-15T00:00:00Z"
    }
  ],
  "next_cursor": null,
  "has_more": false,
  "total": 1
}

{
  "message": "<string>"
}