> ## Documentation Index
> Fetch the complete documentation index at: https://docs.leadstaker.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List field groups

> Answers with the paginated envelope: the matching field groups in `data`, plus `hasMore`, `limit`, `offset` and `total`.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/field-groups
openapi: 3.0.3
info:
  title: Leadstaker API
  version: 1.0.0
  description: Public REST API for Leadstaker projects.
servers:
  - url: https://n-api.leadstaker.com
    description: Production
security: []
tags:
  - name: Fields
    description: >-
      Custom field definitions, both the built-in ones and the ones a project
      creates.
  - name: Field groups
    description: Sections that organize custom fields in the interface.
  - name: Deals
    description: Opportunities moving through a pipeline, each tied to a contact.
  - name: Contacts
    description: >-
      People inside a project, holding the custom field values collected about
      them.
  - name: Messages
    description: Individual messages inside a chat, inbound and outbound.
  - name: Chats
    description: Conversations with a contact over a connected channel.
  - name: Loss reasons
    description: The catalog of reasons a deal can be marked as lost.
  - name: Pipelines
    description: Ordered sets of stages a deal travels through.
  - name: Stages
    description: Steps inside a pipeline, including the built-in open and closed ones.
  - name: Tags
    description: Free-form labels attached to deals.
  - name: Notes
    description: >-
      Free text attached to a contact or a deal, written by a user, an agent, or
      the system.
paths:
  /v1/field-groups:
    get:
      tags:
        - Field groups
      summary: List field groups
      description: >-
        Answers with the paginated envelope: the matching field groups in
        `data`, plus `hasMore`, `limit`, `offset` and `total`.
      operationId: getFieldGroups
      parameters: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          minLength: 1
                        name:
                          type: string
                          minLength: 1
                        entityType:
                          type: string
                          enum:
                            - DEAL
                            - CONTACT
                        position:
                          type: integer
                          minimum: 0
                        code:
                          type: string
                          minLength: 1
                        projectId:
                          type: string
                          minLength: 1
                        archivedAt:
                          type: string
                          format: date-time
                        createdAt:
                          type: string
                          format: date-time
                        updatedAt:
                          type: string
                          format: date-time
                      required:
                        - id
                        - name
                        - entityType
                      additionalProperties: false
                  hasMore:
                    type: boolean
                  limit:
                    type: number
                  offset:
                    type: number
                  total:
                    type: number
                required:
                  - data
                  - hasMore
                  - limit
                  - offset
                  - total
                additionalProperties: false
              example:
                data:
                  - id: 66eab3c47d21ff0011b2d6f0
                    name: Dados de contato
                    entityType: CONTACT
                    position: 0
                    projectId: 665f1c2e8a94b70012d4e9a1
                    createdAt: '2026-01-12T14:08:00.000Z'
                    updatedAt: '2026-01-15T09:32:00.000Z'
                hasMore: false
                limit: 10
                offset: 0
                total: 1
        '401':
          description: Missing or invalid credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - apiKey: []
components:
  schemas:
    Error:
      type: object
      required:
        - errorCode
        - message
        - status
      properties:
        errorCode:
          type: string
        message:
          type: string
        status:
          type: integer
        errors:
          type: array
          items:
            type: object
            required:
              - field
              - code
              - message
            properties:
              field:
                type: string
              code:
                type: string
              message:
                type: string
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key

````