---
title: "Get all instruments"
method: GET
path: "/instruments"
tags: ["Instruments"]
---

# Get all instruments

`GET /instruments`

## Request

- Base URL: `https://www.pulses.com.br/api/engage/v1`
- URL: `https://www.pulses.com.br/api/engage/v1/instruments`
- Auth: API key in header `Authorization`

Returns the list of all instruments.

## Query parameters

- `hierarchical` 0 | 1
- `calculationType` 1 | 2 | 3 | 4
- `locked` 0 | 1
- `sendType` 0 | 1 | 2 | 3

## Response `200`

Successful response

- object[]
  - `id_instrument` integer: ID of the instrument
  - `id_send_group` integer: ID of the send group
  - `id_client` integer: ID of the client
  - `uid_instrument` string, uuid: UUID of the instrument
  - `name` string: Name of the instrument
  - `active` integer: Indicates if the instrument is active to send pulses (instruments not active doesnt have questions sended in the pulse)
  - `locked` integer: Indicates if the instrument is locked to receive answers
  - `type` string: Type of the instrument
  - `calculation_type` integer: Indicates what calculation type the instrument uses. 1 - Answers avarage 2 - Answers categorization 3 - Categorization of the individual 4 - NPS
  - `minimum_respondents` integer: Indicates the minimum number of respondents to display score informations
  - `lagging` integer: Number of weeks that an answer will be valid and considered when counting the instrument score
  - `recency` integer: Number of weeks that a question will not be shown to the user after it has been answered by them
  - `all_at_once` integer: Indicates whether all instrument questions will be sent at once to the user
  - `max_questions` integer: Indicates the maximum number of instrument questions that will be shown in the survey that is sent to users
  - `hierarchical` integer: Indicates if the instrument is hierarchical or not
  - `confidentiality` 0 | 1 | 2: Indicates the confidentiality level of the instrument 0 - Identifiable 1 - Confidential 2 - Partially confidential
  - `first_answer_date` string: When the first answer was inserted
  - `last_answer_date` string: When the last answer was inserted
  - `created_at` string: When the instrument was created
  - `updated_at` string: When the instrument was created
  - `deleted_at` string: When the instrument was deleted, null if it is not deleted

## Other responses

- `404`: Not found response

---

[API](https://skmtc.dev/gupy/apis/api-gupy-clima-e-engajamento.md) - [All operations](https://skmtc.dev/gupy/apis/api-gupy-clima-e-engajamento/llms.txt) - [OpenAPI document](https://skmtc.dev/gupy/apis/api-gupy-clima-e-engajamento/revisions/04af6d64e930?raw)