Read any card (user story, task, bug, feature, epic, test plan, ...) by id: type, name, state, project, parent chain, teams with team states, assignments (who is assigned in which role), role efforts, effort totals, release/iteration, custom fields, tags, counts, and the description as plain text.

Find cards by text in the name (or #id; bare digits match the id and the name), type, state, project, assignee ("me" for yourself) and tag. Open cards only unless includeClosed. Names and states are resolved; ambiguous names are listed, never guessed. Newest-modified first.

Cards assigned to the current user (the token owner), open ones by default, with counts per state.

States available to a card (from its own project's process), or to an entity type in a project. Team sub-workflow states are flagged isTeamWorkflow; for a card, its current state and team states are included.

Find people by name, login or email (every word must match), fully paged over all users. Without a query, lists everyone active. Use the returned ids when a name is ambiguous.

List teams (active by default), optionally filtered by name.

List roles (Developer, Product Owner, ...). hasEffort tells whether a role can carry effort.

List projects (active by default) with abbreviation and process, optionally filtered by name.

Releases, newest first, optionally for one project; currentOnly for releases in progress.

Team iterations (sprints) for a team, or project iterations for a project; newest first. currentOnly for the running ones. Without team or project: current team iterations of every team.

Custom fields of a card's type (or of an entity type in a project) with their type and, for dropdowns, the allowed values. Pass field to see one field.

Comments on a card, oldest first, as plain text, with author and reply parent. When capped, the most recent comments are kept.

Relations of a card in both directions (dependency, blocker, relation, link, duplicate), with the related card.

Time logged on a card, or by a person ("me" for yourself), optionally within dates (YYYY-MM-DD). Returns entries and the total spent. Reads Time entries where the card's process tracks time, and TimeRecord entries where the instance tracks time that way (a story's records include those of its tasks). By person alone, both kinds are returned.

Attachments of a card: name, size, type, owner, date and URL. Downloading needs Basic or cookie auth; with an access token Targetprocess returns an HTML error page instead of the file.

A test plan with its test cases and their steps (in run order), child test plans, and recent test plan runs.

Describe the Targetprocess resource catalog read from this instance. Without a resource: every resource with its operations. With a resource: its fields (settable/required), references and collections (addable/removable). Use it before read_query/write_create.

GET one entity of any resource by id (layer 1). Inner collections in include return up to 1000 items. Prefer read_card for cards.

Query a collection of any resource with where/include/orderBy (layer 1), fully paged. Returns {count, truncated, items}; default limit 500, max 5000. Use include to keep results small.

GET an inner collection of an entity, e.g. UserStories/{id}/Tasks or Bugs/{id}/Comments (layer 1), fully paged. See read_meta for collection names.

Targetprocess REST v2 query (read-only): select with projections and nested collections, where with ==, !=, and, or, aggregations via result, board filter DSL via filter. Entity is singular (userStory, bug, feature). v2 omits null fields: absence means null. Filters use v2 syntax, e.g. where=(entityState.isFinal==false and project.id==2), select={id,name,tasks.count as tasks}.

Change history of an entity, oldest first (when capped, the most recent entries are kept). Simple history (default) records state, effort, release and iteration changes; full: true returns every change with the changed fields and their new values. resource is resolved from the id for cards; pass it for other entities (e.g. Comment).

Targetprocess Context for entity ids, or for projects and teams: processes and their practices (e.g. IsStoryEffortEqualsSumTasksEffort), terms, custom field definitions, selected projects/teams, logged user, version. Without arguments: the global context.

Type conversions of a card (e.g. a bug converted to a user story): the id it has now if it was converted, and the ids it was converted from.

Deleted projects or users (v2 includeDeleted), with their delete date. Restoring them needs admin_undelete and an administrator token.

RESTful storage, where views, boards and settings live. No group: list groups. Group: its storages (select/where in storage syntax, e.g. select={key,publicData.name} where=(scope == "Public")). Group + key: one storage with publicData and userData.

Create any card type (UserStory, Task, Bug, Feature, Epic, TestPlan, Request, ...) with parent, name, description, state, team, assignees, role efforts, tags and custom fields, applying the team rules: the project is inherited from the parent (task ← story, story ← feature, feature ← epic, bug ← its card, test case ← test plan) and the call fails before posting if none resolves; assignments Targetprocess adds by default are removed and reported, then exactly the requested people are assigned; effort is written per role; the parent's state and role efforts before/after are reported. Description: pass format markdown for Markdown; HTML is sent as-is, plain text lines become paragraphs.

Update a card: name, description, tags (tags replaces the whole list; addTags/removeTags edit it), release, iteration, team iteration (null clears), parent, or other settable fields. Description: pass format markdown for Markdown. Changes are read back; removed tags are reported. For a test case, parent ADDS it to that test plan (existing plans are kept). For state, people, effort, teams and custom fields use the dedicated write_* tools.

Move a card to a state by name or id, resolved against the card's own project workflow. With team, sets that team's state on the card (its team sub-workflow, or the project workflow when the team has none). The state is read back, and the parent card's state before/after is reported: moving a task out of its initial state can advance its user story.

Assign a person to a card in a role (names or ids; "me" for yourself). Adds to existing assignments; with exclusive: true, also removes everyone else in that role (only when explicitly asked). Reports what was removed and reads the assignments back.

Remove one exact assignment (person + role) from a card. If the person holds several roles on the card, the role is required.

Set effort for one or more roles on a card. Effort always belongs to a role: this writes the RoleEffort rows, never the card total, which Targetprocess computes from them. A role is required. Task role efforts ROLL UP into the parent user story, overwriting the story's value for that role; the parent's before/after values are reported rather than assuming the story estimate was kept.

Set custom fields on a card by name, e.g. {"BackEnd":"Done","FrontEnd":"To Do"}. Dropdown values are validated against the field's options (see read_custom_field_options) before anything is sent; null clears a field. Values are read back.

Add teams to or remove teams from a card (names or ids). Adding appends; removing deletes only the named team assignment.

Add a comment to a card. Pass format markdown for Markdown; otherwise plain text lines become paragraphs and HTML is sent as-is. replyTo answers another comment.

Log time spent on a card for a person (default: you). date is YYYY-MM-DD (default: today in the server's time zone). Where the card's process tracks time, this is a Time entry and the role defaults to the person's only role on the card (pass role if they have none or several). Where the process has no Time Tracking practice but the instance tracks time in a TimeRecord type, this creates a time record linked to the person and the card (and a task's story); records have no role or remaining time, and Targetprocess names them itself.

Relate two cards: relation Dependency, Blocker, Relation (default), Link or Duplicate (or any type on the instance). outbound (default): id → to (id is the master); inbound: to → id. An existing identical relation is left alone.

Follow (or with unfollow: true, stop following) a card, for yourself or another person.

Create test cases with ordered steps under a test plan. The project is inherited from the test plan. Each case is read back.

Record a test run of a test plan: creates a test plan run (Targetprocess adds a "Not run" test case run per case), then sets each given test case's result (Passed, Failed, Blocked, OnHold, NotRun) with an optional comment.

Create an entity of any resource that supports create (layer 1), validated against the catalog before sending. Nested children may be included, e.g. {"Name":"Story","Project":{"Id":2},"Tasks":{"Items":[{"Name":"T1"}]}}. Never include Id. Custom fields go in "CustomFields":[{"Name","Value"}]. Prefer write_create_card for cards: it applies the team rules.

Update fields of an existing entity (layer 1), validated against the catalog before sending. The response is read back and any requested value that did not persist is reported. Writing a card Effort here bypasses role efforts; use write_set_role_effort instead.

Create or update up to 500 entities of one resource in one call (layer 1). Items with "Id" update, items without create. Every item is validated first; nothing is sent if any item is invalid.

Add items to an addable collection of an entity (layer 1). Collection posts APPEND to what is there; nothing is replaced. For assignments, teams and role efforts prefer write_assign, write_team and write_set_role_effort.

Create or update a storage entry. MERGE semantics: posted publicData/userData keys are added or overwritten, other keys are kept, a null value deletes that key. A missing group or key is created. Scope and publicData can be changed only by the owner or an administrator.

Upload files to a card (UploadFile.ashx). Each file is given as base64 content with a name; pounce never reads local files itself, so the client decides what may be uploaded. Attachments are read back to confirm they arrived.

Delete a card by id alone (its type is resolved). A card with child cards (a story's tasks and bugs, a feature's stories, an epic's features, a test plan's test cases) is only deleted with withChildren: true, since Targetprocess may delete them with it. Reports what was deleted and the parent card's state and efforts before/after.

Delete the relation between two cards, in either direction. If they have several relations, pass relation (type name) to pick one.

Delete one entity of any resource that supports delete (layer 1). Reads it first and reports what was deleted.

Delete up to 500 entities of one resource by id (layer 1). Targetprocess bulk delete works by id only.

Remove items from a removable collection of an entity by child id (layer 1), e.g. unlink test cases from a test plan. To unassign a person prefer write_unassign.

Delete one storage entry (only its owner or an administrator can).

Create a configuration/administration entity. Administration resources only (Project, Team, User, Process, Workflow, EntityState, Role, CustomField, ...). Requires an administrator token.

Update a configuration/administration entity. Administration resources only (Project, Team, User, Process, Workflow, EntityState, Role, CustomField, ...). Requires an administrator token.

Delete a configuration/administration entity. Administration resources only (Project, Team, User, Process, Workflow, EntityState, Role, CustomField, ...). Requires an administrator token.

Add items to a collection of a configuration/administration entity (e.g. Team TeamMembers). Administration resources only (Project, Team, User, Process, Workflow, EntityState, Role, CustomField, ...). Requires an administrator token.

Remove items from a collection of a configuration/administration entity. Administration resources only (Project, Team, User, Process, Workflow, EntityState, Role, CustomField, ...). Requires an administrator token.

Restore deleted entities by id and entity type (e.g. UserStory, Project, User). Administrator token required. Comments, milestones and programs cannot be undeleted.