List - Miru

GET

/

groups

List

curl --request GET \
  --url https://api.mirurobotics.com/beta/groups \
  --header 'Miru-Version: <miru-version>' \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://api.mirurobotics.com/beta/groups"

headers = {
    "Miru-Version": "<miru-version>",
    "X-API-Key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'Miru-Version': '<miru-version>', 'X-API-Key': '<api-key>'}
};

fetch('https://api.mirurobotics.com/beta/groups', 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.mirurobotics.com/beta/groups",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Miru-Version: <miru-version>",
    "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.mirurobotics.com/beta/groups"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Miru-Version", "<miru-version>")
	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.mirurobotics.com/beta/groups")

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

request = Net::HTTP::Get.new(url)
request["Miru-Version"] = '<miru-version>'
request["X-API-Key"] = '<api-key>'

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

{
  "object": "list",
  "limit": 10,
  "offset": 0,
  "has_more": false,
  "data": [
    {
      "object": "group",
      "id": "grp_789",
      "name": "line-3",
      "parent_id": "grp_456",
      "created_at": "2026-01-01T00:00:00Z",
      "updated_at": "2026-01-01T00:00:00Z"
    }
  ],
  "total_count": 123
}

Scope	Required
`groups:read`	Yes

Authorizations

X-API-Key

string

header

required

The API key to use for authentication.

Headers

Miru-Version

string

required

The API version the client was built against.

Example:

"2026-08-17.everglades"

Query Parameters

offset

integer

default:0

The offset of the items to return. An offset of 10 with a limit of 10 returns items 11-20.

Required range: x >= 0

Example:

0

limit

integer

default:10

The maximum number of items to return. A limit of 15 with an offset of 0 returns items 1-15.

Required range: 1 <= x <= 100

Example:

10

order_by

enum<string>[]

Sort order for the group results.

Available options:

id:asc,

id:desc,

created_at:asc,

created_at:desc,

updated_at:asc,

updated_at:desc,

name:asc,

name:desc

Example:

["created_at:desc"]

expand

enum<string>[]

Fields to expand on each group in the list.

Available options:

total_count,

parent

Example:

["parent"]

id

string[]

The group IDs to filter by.

Example:

["grp_123"]

name

string[]

The group names to filter by.

Example:

["production"]

parent_id

string[]

The parent group IDs to filter by.

Example:

["grp_456"]

Response

200 - application/json

Successfully listed the groups.

object

enum<string>

required

The object type, which is always list.

Available options:

list

Example:

"list"

limit

integer

default:10

required

The maximum number of items to return. A limit of 15 with an offset of 0 returns items 1-15.

Required range: 1 <= x <= 100

offset

integer

default:0

required

The offset of the items to return. An offset of 10 with a limit of 10 returns items 11-20.

Required range: x >= 0

has_more

boolean

required

True if there are more items in the list to return. False if there are no more items to return.

Example:

false

data

Group · object[]

required

The list of groups.

Show child attributes

total_count

integer<int64>

The total number of items in the list. By default the total count is not returned. The total count must be expanded (using expand=total_count) to get the total number of items in the list.

Last modified on August 17, 2026

⌘I

List

curl --request GET \
  --url https://api.mirurobotics.com/beta/groups \
  --header 'Miru-Version: <miru-version>' \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://api.mirurobotics.com/beta/groups"

headers = {
    "Miru-Version": "<miru-version>",
    "X-API-Key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'Miru-Version': '<miru-version>', 'X-API-Key': '<api-key>'}
};

fetch('https://api.mirurobotics.com/beta/groups', 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.mirurobotics.com/beta/groups",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Miru-Version: <miru-version>",
    "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.mirurobotics.com/beta/groups"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Miru-Version", "<miru-version>")
	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.mirurobotics.com/beta/groups")

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

request = Net::HTTP::Get.new(url)
request["Miru-Version"] = '<miru-version>'
request["X-API-Key"] = '<api-key>'

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

{
  "object": "list",
  "limit": 10,
  "offset": 0,
  "has_more": false,
  "data": [
    {
      "object": "group",
      "id": "grp_789",
      "name": "line-3",
      "parent_id": "grp_456",
      "created_at": "2026-01-01T00:00:00Z",
      "updated_at": "2026-01-01T00:00:00Z"
    }
  ],
  "total_count": 123
}