---
title: "Consulta dados do instrumento via uid_instrument"
method: GET
path: "/instruments/{uid_instrument}"
tags: ["Instruments"]
---

# Consulta dados do instrumento via uid_instrument

`GET /instruments/{uid_instrument}`

## Request

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

Retorna um instrumento via uid_instrument

## Path parameters

- `uid_instrument` string, required

## Response `200`

Successful response

- GetInstrumentsSuccess
  - `uid_instrument` string, uuid: UUID of the instrument
  - `id_instrument` integer: ID of the instrument
  - `id_send_group` integer: ID of the send group
  - `id_instrument_reference` integer: ID instrument reference
  - `name` string: Name of the instrument
  - `type` string: Type of the instrument
  - `all_at_once` integer: Indicates whether all instrument questions will be sent at once to the user
  - `recency` integer: Number of weeks that a question will not be shown to the user after it has been answered by them
  - `max_questions` integer: Indicates the maximum number of instrument questions that will be shown in the survey that is sent to users
  - `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
  - `hierarchical` integer: Indicates if the instrument is hierarchical or not
  - `anonymous` 0 | 1 | 2: Indicates the confidentiality level of the instrument 0 - Identifiable 1 - Confidential 2 - Partially confidential
  - `messages` string: null
  - `questions_config` object: {}
  - `send_type` 0 | 1 | 2 | 3: 0 - Único | 1 - Recorrente | 2 - Gatilho | 3 - Manual
  - `current_cycle` integer: 0
  - `is_deepening_cycle` integer: 0
  - `frequency` integer: 0
  - `groups` object: []

## 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)