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

# List people

> Return the people in your organization, one page at a time.



## OpenAPI

````yaml api-reference/openapi.json GET /people
openapi: 3.0.0
info:
  title: DSALTA API
  version: 1.0.0
  description: >-
    DSALTA Public API (v1). Authenticate with a Bearer API token issued from
    your organization settings. Each token carries resource-level scopes (e.g.
    documents:read).
  contact: {}
servers:
  - url: https://apip.dsalta.com/v1
    description: Production
security: []
paths:
  /people:
    get:
      tags:
        - People
      summary: List People
      operationId: ListPeople
      parameters:
        - in: query
          name: page
          required: false
          schema:
            type: number
            format: double
        - in: query
          name: limit
          required: false
          schema:
            type: number
            format: double
        - in: query
          name: search
          required: false
          schema:
            type: string
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicListResponse_PublicPerson_'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Example 1:
                  value:
                    success: false
                    message: Invalid or expired API token
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Example 1:
                  value:
                    success: false
                    message: 'API token is missing required scope(s): people:read'
      security:
        - apiToken:
            - people:read
components:
  schemas:
    PublicListResponse_PublicPerson_:
      properties:
        data:
          items:
            $ref: '#/components/schemas/PublicPerson'
          type: array
        pagination:
          $ref: '#/components/schemas/PublicPaginationMeta'
      required:
        - data
        - pagination
      type: object
      additionalProperties: false
    ErrorResponse:
      properties:
        details:
          $ref: '#/components/schemas/Record_string.unknown_'
        message:
          type: string
        success:
          type: boolean
          enum:
            - false
          nullable: false
      required:
        - message
        - success
      type: object
    PublicPerson:
      description: >-
        Public (v1) shape for a person. PII-heavy internally, so this is
        deliberately

        minimal.


        Excluded on purpose: the email, the integration username, employment
        dates

        and termination reason, the background-check and hiring-evaluation URLs

        (exposed only as a boolean), device inventory / security posture, the
        IdP

        directory link, the owner, the off-boarding flag, the IdP source and the

        internal ids.
      properties:
        id:
          type: string
        firstName:
          type: string
        lastName:
          type: string
        title:
          type: string
          nullable: true
        department:
          type: string
          nullable: true
        scope:
          type: string
          description: '"IN_SCOPE" | "OUT_OF_SCOPE".'
        status:
          type: string
          description: '"Current" | "Terminated".'
        backgroundCheckOnFile:
          type: boolean
          description: >-
            Whether a background check is on file. Never the document URL
            itself.
        policyApprovals:
          properties:
            total:
              type: number
              format: double
            passing:
              type: number
              format: double
          required:
            - total
            - passing
          type: object
          description: Policy acceptance progress.
        securityTraining:
          properties:
            total:
              type: number
              format: double
            passing:
              type: number
              format: double
          required:
            - total
            - passing
          type: object
          description: Security-training progress.
        groups:
          items:
            type: string
          type: array
          description: Group names the person belongs to.
        createdAt:
          type: string
        updatedAt:
          type: string
      required:
        - id
        - firstName
        - lastName
        - title
        - department
        - scope
        - status
        - backgroundCheckOnFile
        - policyApprovals
        - securityTraining
        - groups
        - createdAt
        - updatedAt
      type: object
      additionalProperties: false
    PublicPaginationMeta:
      description: >-
        Public API (v1) response envelope.


        The internal controllers are inconsistent — some return
        `SuccessResponse<T>`,

        some a bare `{ data, total }`. The public contract standardises on one
        shape

        so customers integrate against something stable:
          - single item  -> { data: T }
          - collection    -> { data: T[], pagination: {...} }

        These types are part of the published contract. Changing a field here is
        a

        breaking API change, not an internal refactor.
      properties:
        page:
          type: number
          format: double
          description: 1-based page number echoed back from the request.
        limit:
          type: number
          format: double
          description: Page size echoed back from the request.
        total:
          type: number
          format: double
          description: Total number of records across all pages.
        totalPages:
          type: number
          format: double
          description: Total number of pages at this page size.
      required:
        - page
        - limit
        - total
        - totalPages
      type: object
      additionalProperties: false
    Record_string.unknown_:
      properties: {}
      type: object
      description: Construct a type with a set of properties K of type T
  securitySchemes:
    apiToken:
      type: http
      scheme: bearer
      bearerFormat: DSALTA_API_TOKEN

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.