--- title: "Consultar grupo de contrato" method: GET path: "/contract-groups/{id}" tags: ["Contratos"] --- # Consultar grupo de contrato `GET /contract-groups/{id}` ## Request - Base URL: `https://api.tiflux.com/api/v2` - URL: `https://api.tiflux.com/api/v2/contract-groups/{id}` - Auth: HTTP bearer Retorna os dados de um grupo de contrato (modalidade Compartilhado). Grupos de contrato e contratos individuais vêm de tabelas distintas, com identificadores independentes: o mesmo ID pode existir nos dois. Use o campo `kind` da listagem `GET /contracts` para saber qual rota consultar. > Os campos monetários do adendo serão exibidos apenas para usuários com a permissão Visualizar valores dos tickets. Caso o usuário não possua esta permissão, esses campos retornarão `"--"` na resposta. ## Response `200` - object: Grupo de contrato (modalidade Compartilhado) - `id` number, required: Identificador do grupo de contrato - `kind` 'contract_group', required: Origem do registro - `name` string, required: Nome do grupo de contrato - `active` boolean, required: Indica se o grupo de contrato está ativo - `expiration_date` string, nullable, required: Data de expiração do grupo de contrato - `duration` number, nullable, required: Duração do grupo de contrato em meses - `automatic_renewal` boolean, required: Renovação automática - `billing_in_batch` boolean, required: Faturamento em lote - `automatic_billing` boolean, required: Faturamento automático - `billing_days_before` number, nullable, required: Faturar em quantos dias antes. Nulo quando o faturamento automático está desabilitado - `technical_observations` string, nullable: Observações técnicas - `consumption_reminder` object, required: **Depreciado**: use `consumption_reminders`. Formato antigo, de um lembrete só, montado a partir do primeiro lembrete de `consumption_reminders`. Para usuário-cliente vem sem lembrete (`notification` false, `percent` e `emails` nulos). - `notification` boolean, required: Se o primeiro lembrete tem porcentagem e e-mail cadastrados - `percent` number, nullable, required: (%) Menor porcentagem do primeiro lembrete - `emails` string, nullable, required: E-mails do primeiro lembrete, separados por vírgula - `consumption_reminders` object[], required: Lembretes de consumo, do mais antigo para o mais novo. Cada lembrete avisa os e-mails quando o consumo do ciclo atinge cada porcentagem. Vazio para usuário-cliente. - `id` number, required: Identificador do lembrete - `percentages` number[], required: (%) Porcentagens de consumo que disparam o aviso - `emails` string[], required: E-mails que recebem o aviso - `alert_scope` 'contract_only' | 'shifts_only' | 'contract_and_shifts', required: Consumo avisado. No grupo de contrato é sempre `contract_only` - `client` object, required: Objeto contendo informações sobre o cliente associado ao grupo de contrato - `id` number, required: Identificador do cliente - `name` string, required: Nome do cliente - `contract_type` object, required: Objeto contendo informações sobre o tipo de contrato - `id` number, required: Identificador do tipo de contrato - `name` string, required: Nome do tipo de contrato - `modality` 'Shared', required: Nome da modalidade do contrato - `contracts` object[], required: Contratos que compõem o grupo. Contratos removidos do grupo não aparecem - `id` number, required: Identificador do contrato - `name` string, required: Nome do contrato - `allow_appointment` boolean: Indica se o contrato aparece como opção para novos apontamentos - `last_rider` object, nullable, required: Último adendo do grupo de contrato - `id` number, required: Identificador do adendo - `rider_number` number, required: Número do adendo - `release` number, required: Número da versão do adendo - `due_day` number, required: Dia de vencimento - `description` string, nullable, required: Descrição do adendo - `value` union, required: Valor mensal - number, nullable - '--' - `discount_value` union, required: Desconto - number, nullable - '--' - `discount_type` string, nullable, required: Tipo de desconto - `tax` union, required: Taxa - number, nullable - '--' - `files` object[], required: Arquivos anexados. A URL é assinada e expira em 72 horas - `id` number, required: Identificador do arquivo - `file_name` string, required: Nome do arquivo - `content_type` string, nullable, required: Tipo do arquivo - `size` number, nullable, required: Tamanho do arquivo em bytes - `url` string, required: URL temporária para download - `notifications` object[], required: E-mails avisados antes do vencimento e do reajuste - `id` number, required: Identificador da notificação - `email` string, required: E-mail avisado - `period` number, required: Antecedência do aviso, em dias - `cancellation` boolean, nullable, required: Avisa o vencimento do contrato? - `readjust` boolean, nullable, required: Avisa o reajuste do contrato? - `shifts` object[], required: Deslocamentos ativos. Os removidos na tela do contrato ficam de fora - `id` number, required: Identificador do deslocamento - `name` string, required: Nome do deslocamento - `value` union, required: Valor do deslocamento - number, nullable - '--' - `qtd_per_period` number, nullable, required: Quantidade de deslocamentos inclusos por período ## Other responses - `403`: ### **Problemas com permissão** Essa resposta significa que o seu usuário está autenticado corretamente, porém, não possui a permissão ou licença necessária para acessar essa rota - `404`: ### **Grupo de contrato não encontrado** ## Changes - **2026-10-27** `04c2680f0936`: 1 info - added the optional property `contracts/items/allow_appointment` to the response with the `200` status - **2026-10-27** `98fe904b6118`: 3 info - added the required property `files` to the response with the `200` status - added the required property `notifications` to the response with the `200` status - added the required property `shifts` to the response with the `200` status - **2026-10-20** `a3394f8abe2f`: 2 info - response property `consumption_reminder` deprecated - added the required property `consumption_reminders` to the response with the `200` status - **2026-10-01** `8934e614279d`: 3 breaking - response property `last_rider/discount_value` list-of-types was widened by adding types `string` to media type `application/json` of response `200` - response property `last_rider/tax` list-of-types was widened by adding types `string` to media type `application/json` of response `200` - response property `last_rider/value` list-of-types was widened by adding types `string` to media type `application/json` of response `200` - **2026-09-29** `4f09a7c58bcc`: 1 info - endpoint added [Operation history](https://skmtc.dev/tiflux/apis/tiflux-official-api/changes/contract-groups/:id/get.md) --- [API](https://skmtc.dev/tiflux/apis/tiflux-official-api.md) - [All operations](https://skmtc.dev/tiflux/apis/tiflux-official-api/llms.txt) - [OpenAPI document](https://skmtc.dev/tiflux/apis/tiflux-official-api/revisions/2936ac99a76d?raw)