Docs/API reference / Instrument groups

List instrument groups

Requires `developer_api.instrument_groups.list` on the project-scoped Developer API connection. Use the API origin supplied for your deployment. Unknown query parameters and unexpected request bodies are rejected.

GET/dev-api/v1/p/{project_id}/instrument-groupsAll endpoints ↗

The request panel saves credentials and API settings in this browser. Privacy details

Authorization

developerApiKey

AuthorizationBearer <token>

Project-scoped Developer API connection key. Grant only the required operation permissions.

In: header

Path Parameters

project_id*string

Match.*\S.*

Length1 <= length <= 128

Query Parameters

q?string

Search text.

Lengthlength <= 256

limit?integer

Maximum entries to return. Defaults shown are repository defaults; deployed limits may differ.

Range1 <= value <= 100

Default50

cursor?string

Opaque cursor from next_cursor. Keep all filters, resource scope, time range, order, and authorization context unchanged.

Length1 <= length <= 16384

Response Body

`application/json`

bash

curl -X GET "https://example.com/dev-api/v1/p/string/instrument-groups"

json

{
  "request_id": "string",
  "data": [
    {
      "id": "string",
      "name": "string",
      "instruments": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "next_cursor": "string"
}

Authorization

Path Parameters

Query Parameters

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

405application/json

409application/json

413application/json

429application/json

500application/json

503application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`