GitHub: Add field to user owned project

← Projects operations · Get started

Operation github.projects_add_field_for_user

Provider route: POST /users/{username}/projectsV2/{project_number}/fields. 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"]["projectsAddFieldForUser"]>[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.projectsAddFieldForUser(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_add_field_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.username	string	Required within parent
path.project_number	integer	Required within parent
body	JSON	Required within parent
body (oneOf 1)	object	Alternative	Additional keys: not allowed
body (oneOf 1).data_type	string	Required within parent	The field’s data type. One of: text, number, date
body (oneOf 1).name	string	Required within parent	The name of the field.
body (oneOf 2)	Model	Alternative	Expand Add field to user owned project — request body — body / data_type: single select
body (oneOf 3)	object	Alternative	Additional keys: not allowed
body (oneOf 3).data_type	string	Required within parent	The field’s data type. One of: iteration
body (oneOf 3).iteration_configuration	Model	Required within parent	Expand Add field to user owned project — request body — body / data_type: iteration iteration configuration
body (oneOf 3).name	string	Required within parent	The name of the field.

Referenced models: Add field to user owned project — request body — body / data_type: iteration iteration configuration, Add field to user owned project — request body — body / data_type: single select

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 Get project field for user — response body

Referenced models: Get project field for user — response body

Schemas

Get project field for user — response body

Field	Type	Presence	Description and constraints
$	object	Root	A field inside a projects v2 project
configuration	object	Optional	Configuration for iteration fields.
configuration.duration	JSON	Optional
configuration.duration (anyOf 1)	integer	Alternative	The duration of the iteration in days.
configuration.duration (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
configuration.iterations	array	Optional
configuration.iterations[]	Model	Each item	Expand Get project field for user — response body — configuration iterations item
configuration.start_day	JSON	Optional
configuration.start_day (anyOf 1)	integer	Alternative	The day of the week when the iteration starts.
configuration.start_day (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
created_at	string	Required within parent	The time when the field was created. Format: date-time
data_type	string	Required within parent	The field's data type. Known values: assignees, linked_pull_requests, reviewers, labels, milestone, repository, title, text, single_select, number, date, iteration, issue_type, parent_issue, sub_issues_progress
id	JSON	Required within parent
id (anyOf 1)	integer	Alternative	The unique identifier of the field.
id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
issue_field_id	JSON	Optional
issue_field_id (anyOf 1)	integer	Alternative	The ID of the issue field.
issue_field_id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
name	string	Required within parent	The name of the field.
node_id	string	Optional	The node ID of the field.
options	array	Optional	The options available for single select fields.
options[]	Model	Each item	Expand Get project field for user — response body — options item
project_url	string	Required within parent	The API URL of the project that contains the field.
updated_at	string	Required within parent	The time when the field was last updated. Format: date-time

Referenced models: Get project field for user — response body — configuration iterations item, Get project field for user — response body — options item

Add field to user owned project — request body — body / data_type: iteration iteration configuration

Field	Type	Presence	Description and constraints
$	object	Root	The configuration for iteration fields.
duration	integer	Required within parent	The default duration for iterations in days. Individual iterations can override this value.
iterations	array	Optional	Zero or more iterations for the field.
iterations[]	object	Each item	Additional keys: not allowed
iterations[].duration	integer	Required within parent	The duration of the iteration in days.
iterations[].start_date	string	Required within parent	The start date of the iteration. Format: date
iterations[].title	string	Required within parent	The title of the iteration.
start_date	string	Required within parent	The start date of the first iteration. Format: date

Add field to user owned project — request body — body / data_type: single select

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
data_type	string	Required within parent	The field's data type. One of: single_select
name	string	Required within parent	The name of the field.
single_select_options	array	Required within parent	The options available for single select fields. At least one option must be provided when creating a single select field.
single_select_options[]	Model	Each item	Expand Add field to user owned project — request body — body / data_type: single select single select options item

Referenced models: Add field to user owned project — request body — body / data_type: single select single select options item

Get project field for user — response body — configuration iterations item

Field	Type	Presence	Description and constraints
$	object	Root	An iteration setting for an iteration field
completed	boolean	Required within parent	Whether the iteration has been completed.
duration	JSON	Required within parent
duration (anyOf 1)	integer	Alternative	The duration of the iteration in days.
duration (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
id	string	Required within parent	The unique identifier of the iteration setting.
start_date	string	Required within parent	The start date of the iteration. Format: date
title	object	Required within parent	The iteration title, in raw text and HTML formats.
title.html	string	Required within parent
title.raw	string	Required within parent

Get project field for user — response body — options item

Field	Type	Presence	Description and constraints
$	object	Root	An option for a single select field
color	string	Required within parent	The color associated with the option.
description	object	Required within parent	The description of the option, in raw text and HTML formats.
description.html	string	Required within parent
description.raw	string	Required within parent
id	string	Required within parent	The unique identifier of the option.
name	object	Required within parent	The display name of the option, in raw text and HTML formats.
name.html	string	Required within parent
name.raw	string	Required within parent

Add field to user owned project — request body — body / data_type: single select single select options item

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
color	string	Optional	The color associated with the option. One of: BLUE, GRAY, GREEN, ORANGE, PINK, PURPLE, RED, YELLOW
description	string	Optional	The description of the option.
name	string	Optional	The display name of the option.

Policy, approvals and errors

SDK function policy ID: github.projects_add_field_for_user. Catalog operation: projects/add-field-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