GitHub: Create a view for a user-owned project

GitHub projects.projectsCreateViewForUser: arguments, response, policy and SDK examples.

Operation github.projects_create_view_for_user

Provider route: POST /users/{user_id}/projectsV2/{project_number}/views. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/github with npm, or alter-sdk-github with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { GitHubIntegration } from "@alter-ai/github";

async function execute(input: Parameters<GitHubIntegration["projects"]["projectsCreateViewForUser"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new GitHubIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.projects.projectsCreateViewForUser(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_github import GitHubIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = GitHubIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.projects.projects_create_view_for_user(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`path`	object	Required within parent	Additional keys: not allowed
`path.user_id`	string	Required within parent
`path.project_number`	integer	Required within parent
`body`	Model	Required within parent	Expand Create a view for a user-owned project — request body — body

Referenced models: Create a view for a user-owned project — request body — body

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
`$`	Model	Root	Expand Create a view for a user-owned project — response body

Referenced models: Create a view for a user-owned project — response body

Schemas

Create a view for a user-owned project — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	A view inside a projects v2 project
`created_at`	string	Required within parent	The time when the view was created. Format: date-time
`creator`	JSON	Required within parent
`creator (allOf 1)`	Model	All variants apply	Expand List users — response body — item
`filter`	JSON	Optional
`filter (anyOf 1)`	string	Alternative	The filter query for the view.
`filter (anyOf 2)`	null	Alternative
`group_by`	array	Required within parent	The list of field IDs used for horizontal grouping.
`group_by[]`	JSON	Each item
`group_by[] (anyOf 1)`	integer	Alternative
`group_by[] (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`html_url`	string	Required within parent	The web URL of the view. Format: uri
`id`	JSON	Required within parent
`id (anyOf 1)`	integer	Alternative	The unique identifier of the view.
`id (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`layout`	string	Required within parent	The layout of the view. Known values: table, board, roadmap
`name`	string	Required within parent	The name of the view.
`node_id`	string	Required within parent	The node ID of the view.
`number`	JSON	Required within parent
`number (anyOf 1)`	integer	Alternative	The number of the view within the project.
`number (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`project_url`	string	Required within parent	The API URL of the project that contains the view.
`sort_by`	array	Required within parent	The sorting configuration for the view. Each element is a tuple of [field_id, direction] where direction is "asc" or "desc".
`sort_by[]`	array	Each item	Maximum items: 2 Minimum items: 2
`sort_by[][]`	JSON	Each item
`sort_by[][] (anyOf 1)`	JSON	Alternative
`sort_by[][] (anyOf 1) (anyOf 1)`	integer	Alternative
`sort_by[][] (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`sort_by[][] (anyOf 2)`	string	Alternative
`updated_at`	string	Required within parent	The time when the view was last updated. Format: date-time
`vertical_group_by`	array	Required within parent	The list of field IDs used for vertical grouping (board layout).
`vertical_group_by[]`	JSON	Each item
`vertical_group_by[] (anyOf 1)`	integer	Alternative
`vertical_group_by[] (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`visible_fields`	array	Required within parent	The list of field IDs that are visible in the view.
`visible_fields[]`	JSON	Each item
`visible_fields[] (anyOf 1)`	integer	Alternative
`visible_fields[] (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: List users — response body — item

Create a view for a user-owned project — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`filter`	string	Optional	The filter query for the view. See [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information.
`group_by`	array	Optional	The field IDs to group items by (horizontal grouping). Supports a single field. The field must support grouping; fields such as `Title`, `Reviewers`, `Linked pull requests`, `Sub-issues progress`, `Tracked by`, and `Tracks` cannot be grouped on. Maximum items: 1
`group_by[]`	integer	Each item
`layout`	string	Required within parent	The layout of the view. One of: table, board, roadmap
`name`	string	Required within parent	The name of the view.
`sort_by`	array	Optional	Sorting configuration for the view. Each element is a two-element array of `[field_id, direction]` where `direction` is `"asc"` or `"desc"`. Supports multiple sort criteria applied in order.
`sort_by[]`	array	Each item	Maximum items: 2 Minimum items: 2
`sort_by[][]`	JSON	Each item
`sort_by[][] (oneOf 1)`	integer	Alternative
`sort_by[][] (oneOf 2)`	string	Alternative
`vertical_group_by`	array	Optional	The field IDs to use as columns in `board` layout (vertical grouping). Supports a single field. The field must support grouping; fields such as `Title`, `Reviewers`, `Linked pull requests`, `Sub-issues progress`, `Tracked by`, and `Tracks` cannot be grouped on. Maximum items: 1
`vertical_group_by[]`	integer	Each item
`visible_fields`	array	Optional	`visible_fields` is not applicable to `roadmap` layout views. For `table` and `board` layouts, this represents the field IDs that should be visible in the view. If not provided, the default visible fields will be used.
`visible_fields[]`	integer	Each item

List users — response body — item

Field	Type	Presence	Description and constraints
`$`	object	Root	A GitHub user.
`avatar_url`	string	Required within parent	Format: uri
`email`	JSON	Optional
`email (anyOf 1)`	string	Alternative
`email (anyOf 2)`	null	Alternative
`events_url`	string	Required within parent
`followers_url`	string	Required within parent	Format: uri
`following_url`	string	Required within parent
`gists_url`	string	Required within parent
`gravatar_id`	JSON	Required within parent
`gravatar_id (anyOf 1)`	string	Alternative
`gravatar_id (anyOf 2)`	null	Alternative
`html_url`	string	Required within parent	Format: uri
`id`	JSON	Required within parent
`id (anyOf 1)`	integer	Alternative	Format: int64
`id (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`login`	string	Required within parent
`name`	JSON	Optional
`name (anyOf 1)`	string	Alternative
`name (anyOf 2)`	null	Alternative
`node_id`	string	Required within parent
`organizations_url`	string	Required within parent	Format: uri
`received_events_url`	string	Required within parent	Format: uri
`repos_url`	string	Required within parent	Format: uri
`site_admin`	boolean	Required within parent
`starred_at`	string	Optional
`starred_url`	string	Required within parent
`subscriptions_url`	string	Required within parent	Format: uri
`type`	string	Required within parent
`url`	string	Required within parent	Format: uri
`user_view_type`	string	Optional

Policy, approvals and errors

SDK function policy ID: github.projects_create_view_for_user. Catalog operation: projects/create-view-for-user. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"X-GitHub-Api-Version": "2026-03-10", "User-Agent": "Alter", "Accept": "application/vnd.github+json"}

Official provider source

Report an issue with this page