---
updatedAt: 2025-06-05T21:40:07.000Z
agentTools:
  projectIndex: https://apidocs.officient.io/llms.txt
---

# List people

Scope required: basics:read

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "officient-api",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://api.officient.io"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "oauth2",
        "flows": {}
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/1.0/people/list": {
      "get": {
        "summary": "List people",
        "description": "",
        "operationId": "list-people",
        "parameters": [
          {
            "name": "page",
            "in": "query",
            "description": "Controls pagination (0, 1, 2, ..) to view all results. 30 items per page.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 0
            }
          },
          {
            "name": "include_archived",
            "in": "query",
            "description": "Include archived people in response",
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 0
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"data\": [{\n            \"id\": 264,\n            \"name\": \"Walter White\",\n            \"email\": \"walter@white.com\",\n            \"role_name\": \"Chemist\",\n            \"archived\": 0,\n            \"linked_payroll_provider_external_id\": \"123\",\n      \t\t\t\"payroll_provider\": \"DemoPayroll\",\n      \t\t\t\"linked_integration_alias\": \"DM\"\n        },\n        {\n            \"id\": 263,\n            \"name\": \"Gustavo Fring\",\n            \"email\": null,\n            \"role_name\": \"Investor\",\n            \"archived\": 0,\n            \"linked_payroll_provider_external_id\": \"124\",\n          \t\"payroll_provider\": \"DemoPayroll\",\n      \t\t\t\"linked_integration_alias\": \"DM\"\n        },\n        {\n            \"id\": 262,\n            \"name\": \"Jesse Pinkman\",\n            \"email\": \"jesse@white.com\",\n            \"role_name\": \"Assistant\",\n            \"archived\": 1,\n            \"linked_payroll_provider_external_id\": \"125\",\n          \t\"payroll_provider\": \"\",\n      \t\t\t\"linked_integration_alias\": \"\"\n        }\n    ],\n    \"total_record_count\": 3 \n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "integer",
                            "example": 264,
                            "default": 0
                          },
                          "name": {
                            "type": "string",
                            "example": "Walter White"
                          },
                          "email": {
                            "type": "string",
                            "example": "walter@white.com"
                          },
                          "role_name": {
                            "type": "string",
                            "example": "Chemist"
                          },
                          "archived": {
                            "type": "integer",
                            "example": 0,
                            "default": 0
                          },
                          "linked_payroll_provider_external_id": {
                            "type": "string",
                            "example": "123"
                          },
                          "payroll_provider": {
                            "type": "string",
                            "example": "DemoPayroll"
                          },
                          "linked_integration_alias": {
                            "type": "string",
                            "example": "DM"
                          }
                        }
                      }
                    },
                    "total_record_count": {
                      "type": "integer",
                      "example": 3,
                      "default": 0
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": false,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```