SanSignal
Book a demo
Platform guidesAPI reference

Find a guide, feature, or API endpoint. Try “FTP”, “alerts”, or “instruments”.

Search all guides and API endpoints Tab to navigate · Enter to open
Browse documentation

Docs/API reference / Instrument groups

Read instrument groups

Requires `developer_api.instrument_groups.read` 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-groups/{group_id}All endpoints ↗

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

GET
/dev-api/v1/p/{project_id}/instrument-groups/{group_id}

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
group_id*string
Match.*\S.*
Length1 <= length <= 128

Query Parameters

include_archived?boolean

Include archived resources explicitly. Archived history still requires authorization.

Defaultfalse

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

bash
curl -X GET "https://example.com/dev-api/v1/p/string/instrument-groups/string"
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"
  }
}
SanSignal documentationQuestions? Contact us ↗