> ## Documentation Index > Fetch the complete documentation index at: https://br.developers.hubspot.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Retrieves a list of users from an account > **Supported products** > **Required Scopes** ## OpenAPI ````yaml specs/legacy/v3/settings-user-provisioning-v3.json GET /settings/users/v3 openapi: 3.0.1 info: title: Provisionamento de usuário description: Basepom for all HubSpot Projects version: v3 x-hubspot-product-tier-requirements: marketing: FREE sales: FREE service: FREE cms: FREE commerce: FREE crmHub: FREE dataHub: FREE x-hubspot-api-use-case: >- Você gerencia os dados de acesso dos funcionários em um sistema externo e deseja garantir que usuários específicos sejam alocados dinamicamente para as equipes corretas em sua conta da HubSpot. x-hubspot-related-documentation: - name: User Provisioning Guide url: >- https://developers.hubspot.com/docs/guides/api/settings/users/user-provisioning x-hubspot-introduction: >- Use a API de provisionamento de usuários para criar e gerenciar usuários na sua conta da HubSpot, bem como suas equipes e funções associadas. servers: - url: https://api.hubapi.com security: [] tags: - name: Basic - name: Equipes - name: Funções - name: Roles - name: Teams - name: Users - name: Usuários paths: /settings/users/v3: get: tags: - Basic operationId: get-/settings/users/v3_/settings/users/v3 parameters: - name: after in: query required: false style: form explode: true schema: type: string - name: limit in: query required: false style: form explode: true schema: type: integer format: int32 responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/CollectionResponsePublicUserForwardPaging' default: $ref: '#/components/responses/Error' description: '' security: - oauth2: - crm.objects.users.read - oauth2: - settings.users.read components: schemas: CollectionResponsePublicUserForwardPaging: required: - results type: object properties: paging: $ref: '#/components/schemas/ForwardPaging' results: type: array items: $ref: '#/components/schemas/PublicUser' ForwardPaging: type: object properties: next: $ref: '#/components/schemas/NextPage' description: >- Informações de paginação para paginação somente para frente. Contém a referência da próxima página quando há mais resultados disponíveis; é omitida ou fica vazia na última página. PublicUser: required: - email - id - roleIds - superAdmin type: object properties: email: type: string description: O e-mail do usuário. firstName: type: string description: O nome do usuário. id: type: string description: O ID exclusivo do usuário. lastName: type: string description: O sobrenome do usuário. primaryTeamId: type: string description: A equipe principal do usuário roleId: type: string description: A função do usuário. roleIds: type: array description: Uma lista dos IDs de função atribuídos ao usuário. items: type: string seatNames: type: array items: type: string secondaryTeamIds: type: array description: As equipes adicionais do usuário. items: type: string sendWelcomeEmail: type: boolean description: >- Indica se um e-mail de boas-vindas foi enviado ao usuário. Este valor será preenchido apenas em resposta a uma solicitação de provisionamento. Consultas subsequentes retornarão falso. superAdmin: type: boolean description: Se o usuário tem privilégios de superadministrador. Error: required: - category - correlationId - message type: object properties: category: type: string description: A categoria de erro context: type: object additionalProperties: type: array items: type: string description: Contexto sobre a condição do erro example: >- {invalidPropertyName=[propertyValue], missingScopes=[scope1, scope2]} correlationId: type: string description: >- Um identificador exclusivo para a solicitação. Inclua este valor em relatórios de erro ou tickets de suporte format: uuid example: aeb5f871-7f07-4993-9211-075dc63e7cbf errors: type: array description: mais informações sobre o erro items: $ref: '#/components/schemas/ErrorDetail' links: type: object additionalProperties: type: string description: >- Um mapa de nomes de links para URIs associados que contêm documentação sobre o erro ou as etapas de correção recomendadas message: type: string description: >- Uma mensagem legível por humanos que descreve o erro, juntamente com as etapas de correção, quando apropriado example: An error occurred subCategory: type: string description: >- Uma categoria específica que contém mais detalhes específicos sobre o erro description: >- Representa uma resposta de erro retornada pela API quando uma operação falha. Este componente é usado em vários endpoints para fornecer informações detalhadas sobre o erro encontrado. example: message: Invalid input (details will vary based on the error) correlationId: aeb5f871-7f07-4993-9211-075dc63e7cbf category: VALIDATION_ERROR links: knowledge-base: https://www.hubspot.com/products/service/knowledge-base NextPage: required: - after type: object properties: after: type: string description: Um token de cursor de paginação para recuperar páginas subsequentes. link: type: string description: >- Um URL que pode ser usado para recuperar os resultados da próxima página. description: >- Especifica as informações de paginação necessárias para recuperar o próximo conjunto de resultados em uma resposta de API paginada ErrorDetail: required: - message type: object properties: code: type: string description: O código de status associado ao detalhe do erro context: type: object additionalProperties: type: array items: type: string description: Contexto sobre a condição do erro example: '{missingScopes=[scope1, scope2]}' in: type: string description: O nome do campo ou parâmetro no qual o erro foi encontrado. message: type: string description: >- Uma mensagem legível por humanos que descreve o erro, juntamente com as etapas de correção, quando apropriado subCategory: type: string description: >- Uma categoria específica que contém mais detalhes específicos sobre o erro description: >- Representa informações detalhadas sobre um erro ocorrido na API. Este componente é usado para fornecer contexto e detalhes adicionais sobre os erros, geralmente como parte de uma resposta de erro. responses: Error: description: An error occurred. content: '*/*': schema: $ref: '#/components/schemas/Error' securitySchemes: oauth2: type: oauth2 flows: authorizationCode: authorizationUrl: https://app.hubspot.com/oauth/authorize tokenUrl: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.users.read: '' crm.objects.users.write: '' settings.users.read: '' settings.users.teams.read: '' settings.users.write: '' ````