slack_kit

{
  "args": {
    "cursor": {
      "desc": "Set `cursor` to `next_cursor` returned by the previous call to list items in the next page.",
      "example": "5c3e53d5",
      "required": false,
      "type": "string"
    },
    "include_admins": {
      "desc": "If true, only admin users will be returned (excludes owners). Returns all admins and owners when combined with `include_owners`. Cannot be used together with `only_guests`.",
      "required": false,
      "type": "boolean"
    },
    "include_deactivated_user_workspaces": {
      "desc": "Only applies with org token and no team\\_id. If true, return `workspaces` for a user even if they may be deactivated on them. If false, return `workspaces` for a user only when user is active on them. Default is false.",
      "required": false,
      "type": "boolean"
    },
    "include_owners": {
      "desc": "If true, only owner users will be returned. Cannot be used together with `only_guests`.",
      "required": false,
      "type": "boolean"
    },
    "is_active": {
      "desc": "If true, only active users will be returned. If false, only deactivated users will be returned. Default is true.",
      "required": false,
      "type": "boolean"
    },
    "limit": {
      "default": "100",
      "desc": "Limit for how many users to be retrieved per page",
      "example": "50",
      "required": false,
      "type": "integer"
    },
    "only_guests": {
      "desc": "If true, returns only guests and their expiration dates that belong to the team\\_id",
      "required": false,
      "type": "boolean"
    },
    "team_id": {
      "desc": "The ID (T1234) of a workspace. Filters results to just the specified workspace.",
      "required": false
    }
  },
  "desc": "List users on a workspace",
  "errors": {
    "feature_not_enabled": "The Admin APIs feature is not enabled for this team.",
    "include_deactivated_user_workspaces_invalid": "`include_deactivated_user_workspaces` only applies with org token and no team\\_id.",
    "invalid_cursor": "The passed cursor could not be validated.",
    "team_not_found": "`team_id` was not found."
  },
  "rate_limit": {
    "label": "Tier 4: 100+ per minute",
    "url": "https://docs.slack.dev/apis/web-api/rate-limits"
  },
  "scopes": {
    "user": [
      {
        "name": "admin.users:read",
        "url": "https://docs.slack.dev/reference/scopes/admin.users.read"
      }
    ]
  }
}