---
updatedAt: 2025-11-11T01:59:44.000Z
agentTools:
  projectIndex: https://docs.codecov.com/llms.txt
---

# User list

Returns a paginated list of users for the specified owner (org)

# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "Codecov API",
    "version": "2.0.0",
    "description": "Public Codecov API"
  },
  "paths": {
    "/{service}/{owner_username}/users/": {
      "get": {
        "operationId": "users_list",
        "description": "Returns a paginated list of users for the specified owner (org)",
        "summary": "User list",
        "parameters": [
          {
            "in": "query",
            "name": "activated",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "in": "query",
            "name": "is_admin",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "in": "path",
            "name": "owner_username",
            "schema": {
              "type": "string"
            },
            "description": "username from service provider",
            "required": true
          },
          {
            "name": "page",
            "required": false,
            "in": "query",
            "description": "A page number within the paginated result set.",
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "page_size",
            "required": false,
            "in": "query",
            "description": "Number of results to return per page.",
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "search",
            "required": false,
            "in": "query",
            "description": "A search term.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "path",
            "name": "service",
            "schema": {
              "type": "string",
              "enum": [
                "bitbucket",
                "bitbucket_server",
                "github",
                "github_enterprise",
                "gitlab",
                "gitlab_enterprise"
              ]
            },
            "description": "Git hosting service provider",
            "required": true
          }
        ],
        "tags": [
          "Users"
        ],
        "security": [
          {
            "tokenAuth": []
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PaginatedUserList"
                }
              }
            },
            "description": ""
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "PaginatedUserList": {
        "type": "object",
        "required": [
          "count",
          "results"
        ],
        "properties": {
          "count": {
            "type": "integer",
            "example": 123
          },
          "next": {
            "type": "string",
            "nullable": true,
            "format": "uri",
            "example": "http://api.example.org/accounts/?page=4"
          },
          "previous": {
            "type": "string",
            "nullable": true,
            "format": "uri",
            "example": "http://api.example.org/accounts/?page=2"
          },
          "results": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/User"
            }
          }
        }
      },
      "ServiceEnum": {
        "enum": [
          "github",
          "gitlab",
          "bitbucket",
          "github_enterprise",
          "gitlab_enterprise",
          "bitbucket_server"
        ],
        "type": "string",
        "description": "* `github` - Github\n* `gitlab` - Gitlab\n* `bitbucket` - Bitbucket\n* `github_enterprise` - Github Enterprise\n* `gitlab_enterprise` - Gitlab Enterprise\n* `bitbucket_server` - Bitbucket Server"
      },
      "User": {
        "type": "object",
        "properties": {
          "service": {
            "$ref": "#/components/schemas/ServiceEnum"
          },
          "username": {
            "type": "string",
            "nullable": true
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "activated": {
            "type": "boolean"
          },
          "is_admin": {
            "type": "boolean"
          },
          "email": {
            "type": "string",
            "nullable": true
          }
        },
        "required": [
          "activated",
          "is_admin",
          "service"
        ]
      }
    },
    "securitySchemes": {
      "tokenAuth": {
        "type": "http",
        "scheme": "bearer"
      }
    }
  },
  "servers": [
    {
      "url": "https://api.codecov.io/api/v2/"
    }
  ],
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```