> ## Documentation Index > Fetch the complete documentation index at: https://docs.connectadesk.com/llms.txt > Use this file to discover all available pages before exploring further. # Listar perfis de permissões > Lista os perfis de permissões da empresa, com o que cada um permite. Use o `id` como `profileId` ao convidar (`POST /users/invites`) ou editar (`PUT /users/{id}`) um usuário. O módulo `profiles` é somente leitura: o token aceita apenas `profiles: GET`. Perfis são criados e editados na tela de perfis do Connecta DESK. Os perfis padrão (Admin e Atendente, com `systemKey`) vêm primeiro, seguidos dos demais em ordem alfabética. ## OpenAPI ````yaml /api-reference/openapi.yaml get /profiles openapi: 3.0.3 info: title: Connecta DESK API pública version: 1.0.0 description: > API pública do Connecta DESK, disponível em `/api/v1`. O acesso é feito com um token gerado no módulo de tokens. Cada token tem permissões por **módulo × método**, e toda leitura de lista é paginada. ## Autenticação ``` Authorization: Bearer sk_live_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6 ``` O token pertence a uma **empresa**, e não a um usuário. A empresa usada é sempre a do token, então enviar `companyId` no corpo não tem efeito. Token ausente, inválido, revogado ou expirado recebe a mesma resposta `401`. ## Ordem de verificação 1. **token** → `401` 2. **empresa ativa** → `403` 3. **API habilitada no plano** → `403 ERR_API_NOT_ENABLED` (não se aplica a on-premise) 4. **rate limit da empresa** → `429` 5. **permissão do token** → `403 ERR_API_FORBIDDEN_SCOPE` ## Ids de usuário Todo id de usuário na API é o id do usuário **nesta empresa**, o mesmo que `GET /users` devolve. Vale para o que a API responde (`user.id`, `assignedTo.id`, `userCreated.id`) e para o que ela aceita (`userId`, `userIds`, `assignedToUserId` e o `{id}` das rotas de usuário). A mesma pessoa pode trabalhar em várias empresas, com nome e perfil diferentes em cada uma, e tem um id diferente em cada empresa. Um id que não pertence a esta empresa responde `404`, com a mesma mensagem de um id inexistente. ## Paginação Todo `GET` de lista é paginado. O `meta` traz apenas `page`, `perPage` e `hasMore`, sem o total de registros. Para percorrer tudo, avance `page` enquanto `hasMore` for `true`. ## Idempotência Opcional em `POST`/`PUT`, pelo header `Idempotency-Key`. Se você repetir a chamada com a mesma chave e o mesmo corpo, recebe a resposta já gravada (com `Idempotent-Replay: true`). Com a mesma chave e um corpo diferente, a resposta é `409`. servers: - url: https://api.connectadesk.com/api/v1 description: Produção security: - apiToken: [] tags: - name: contacts description: Cadastro de contatos, campos extras e origem de marketing. - name: tickets x-displayName: Conversas description: Abertura, transferência, encerramento e qualificação de conversas. - name: messages description: Envio assíncrono e leitura de mensagens. - name: tags description: Tags e vínculo com atendimentos. - name: queues description: Filas de atendimento e seus atendentes. - name: wrapups description: Tipos de qualificação. - name: users description: Atendentes e administradores. - name: schedules description: Mensagens programadas. - name: quick-messages description: Respostas rápidas. - name: campaigns description: Disparos em massa. - name: crm description: Painéis, etapas, cards e indicadores. - name: channels description: Canais (somente leitura). - name: reports description: Relatórios e dashboards. - name: products description: Catálogo de produtos, categorias e desempenho nas vendas. - name: custom-fields description: >- Campos personalizados de contato e de card, e variáveis globais da empresa. - name: profiles description: Perfis de permissões da empresa (somente leitura). - name: webchat description: >- Webchat nativo pelo seu sistema: abrir sessão de um visitante, enviar e ler mensagens. O token precisa do escopo `webchat` (GET e POST). paths: /profiles: get: tags: - profiles summary: Listar perfis de permissões description: > Lista os perfis de permissões da empresa, com o que cada um permite. Use o `id` como `profileId` ao convidar (`POST /users/invites`) ou editar (`PUT /users/{id}`) um usuário. O módulo `profiles` é somente leitura: o token aceita apenas `profiles: GET`. Perfis são criados e editados na tela de perfis do Connecta DESK. Os perfis padrão (Admin e Atendente, com `systemKey`) vêm primeiro, seguidos dos demais em ordem alfabética. parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/perPage' - name: search in: query description: Busca por nome ou descrição. schema: type: string example: supervisor responses: '200': description: OK content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/Profile' meta: $ref: '#/components/schemas/PageMeta' '403': $ref: '#/components/responses/Forbidden' components: parameters: page: name: page in: query description: Número da página, começando em 1. Um valor inválido é tratado como 1. schema: type: integer minimum: 1 default: 1 example: 1 perPage: name: perPage in: query description: >- Quantidade de itens por página. O máximo depende do ambiente (padrão 100). schema: type: integer minimum: 1 maximum: 100 default: 20 example: 50 schemas: Profile: type: object description: > Perfil de permissões. Cada usuário da empresa, exceto o proprietário, tem um perfil, e é ele que define o que a pessoa pode ver e fazer. properties: id: type: integer description: Use como `profileId` em `POST /users/invites` e `PUT /users/{id}`. example: 21 name: type: string example: Atendente description: type: string nullable: true systemKey: type: string nullable: true enum: - admin - agent - null description: > Marca os perfis padrão, que toda empresa tem e que não podem ser excluídos. `null` para os perfis criados pela empresa. | valor | significado | | --- | --- | | `admin` | Perfil padrão **Admin**. | | `agent` | Perfil padrão **Atendente**. | usersCount: type: integer description: Usuários da empresa com este perfil. example: 8 permissions: type: object description: > O que o perfil permite, por recurso. Traz todos os recursos da plataforma, inclusive os que o perfil não acessa (com `value: "none"`). A chave é o módulo (`contacts`, `conversations`, `crm_boards`...) ou uma ação dentro dele (`contacts.export`, `contacts.delete`...). O valor já é o **efetivo**: uma ação nunca vale mais do que o módulo permite. Por exemplo, com `contacts` em `view`, `contacts.delete` vem `none` mesmo que esteja marcada no perfil. | `value` | significado | | --- | --- | | `none` | Sem acesso. | | `view` | Consultar. | | `edit` | Consultar e editar o que já existe. | | `admin` | Também criar, excluir, ativar e inativar. | | `yes` | Ação liberada (recursos do tipo liga/desliga). | | `scope` | significado | | --- | --- | | `all` | Todos os registros da empresa. | | `own` | Só os registros da própria pessoa. | | `null` | O recurso não tem abrangência. | additionalProperties: type: object properties: value: type: string enum: - none - view - edit - admin - 'yes' scope: type: string nullable: true enum: - all - own - null example: contacts: value: edit scope: all contacts.export: value: none scope: null conversations: value: edit scope: own notifications: type: object description: > A partir de qual prioridade o perfil recebe cada tipo de aviso da plataforma. O proprietário da empresa recebe todos. | tipo | avisos | | --- | --- | | `announcement` | Informativos publicados pelo Connecta, como lançamentos e manutenções. | | `system_event` | Eventos automáticos, como canal desconectado, limites do plano, créditos e pagamento pendente. | | valor | recebe | | --- | --- | | `none` | Nada. | | `urgent` | Só os urgentes. | | `high` | Alta ou superior. | | `medium` | Média ou superior. | | `low` | Todos. | properties: announcement: type: string enum: - none - urgent - high - medium - low example: medium system_event: type: string enum: - none - urgent - high - medium - low example: high createdAt: type: string format: date-time updatedAt: type: string format: date-time PageMeta: type: object required: - page - perPage - hasMore properties: page: type: integer example: 1 perPage: type: integer example: 20 hasMore: type: boolean description: Indica se há mais registros além desta página. example: true example: page: 1 perPage: 20 hasMore: true Error: type: object required: - error properties: error: type: object required: - code - message properties: code: type: string description: Código fixo do erro, para você tratar cada caso no seu sistema. example: ERR_API_FORBIDDEN_SCOPE message: type: string details: {} responses: Forbidden: description: Empresa inativa, API não habilitada no plano ou permissão insuficiente. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: ERR_API_FORBIDDEN_SCOPE message: >- O token não tem permissão para este método neste módulo. A mensagem real nomeia os dois. securitySchemes: apiToken: type: http scheme: bearer description: Token da API no formato `sk_live_…`. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.