client.projectsOperation methods
Parameter declarations below are taken from the pinned TypeScript source. Request fields and responses are summarized from the matching OpenAPI operation; follow the API link for every field, constraint, example, and error description.
/projectsprojects.list
Use this operation to list projects. It returns only resources visible to the credential and applies the documented filters before producing a bounded, stable page. Required scopes, product permissions, sharing rules, workspace locks, and regional cell ownership are enforced for every request.
client.projects.list(options: ProjectListOptions = {})- Return form
Promise- Operation ID
listProjects- Required scopes
projects:read- SDK parameters
options: ProjectListOptions- Query request fields
cursor?: stringlimit?: integerarchived?: booleancompleted?: booleancontactId?: stringcreatedById?: stringindividualId?: stringlistId?: stringmanagerId?: stringsubscriberId?: string- Success
200 Array<Project> envelope
/projectsprojects.create
Use this operation to create a project. The server validates the complete payload and derives workspace ownership from the authenticated credential. Required scopes, product permissions, sharing rules, workspace locks, and regional cell ownership are enforced for every request. Use a stable Idempotency-Key when retrying so a transport timeout cannot create duplicate work.
client.projects.create(data: ProjectCreate, options?: MutationOptions)- Return form
Promise- Operation ID
createProject- Required scopes
projects:write- SDK parameters
data: ProjectCreateoptions: MutationOptions- Header request fields
Idempotency-Key: string- Request body
ProjectCreateapplication/json- Success
200 Project envelope201 Project envelope
/projects/{id}projects.get
Use this operation to get a project. It returns the resource only when it belongs to the authenticated workspace and is visible to the credential. Required scopes, product permissions, sharing rules, workspace locks, and regional cell ownership are enforced for every request.
client.projects.get(id: string, options?: RequestOptions)- Return form
Promise- Operation ID
getProject- Required scopes
projects:read- SDK parameters
id: stringoptions: RequestOptions- Path request fields
id: string- Success
200 Project envelope
/projects/{id}projects.update
Requires exactly one latest strong resource ETag. The cell-local App re-authenticates and atomically compares the tenant-bound revision before mutation.
client.projects.update(id: string, data: ProjectUpdate, options: ProjectMutationOptions)- Return form
Promise- Operation ID
updateProject- Required scopes
projects:write- SDK parameters
id: stringdata: ProjectUpdateoptions: ProjectMutationOptions- Path request fields
id: string- Header request fields
If-Match: string- Request body
ProjectUpdateapplication/json- Success
200 Project envelope
/projects/{id}/sharingprojects.getSharing
Use this operation to get project sharing. It returns the resource only when it belongs to the authenticated workspace and is visible to the credential. Required scopes, product permissions, sharing rules, workspace locks, and regional cell ownership are enforced for every request.
client.projects.getSharing(id: string, options?: RequestOptions)- Return form
Promise- Operation ID
getProjectSharing- Required scopes
projects:sharing- SDK parameters
id: stringoptions: RequestOptions- Path request fields
id: string- Success
200 ProjectSharing envelope
/projects/{id}/sharingprojects.replaceSharing
Requires exactly one latest strong resource ETag. The cell-local App re-authenticates and atomically compares the tenant-bound revision before mutation.
client.projects.replaceSharing(id: string, data: ProjectSharingReplace, options: ProjectSharingMutationOptions)- Return form
Promise- Operation ID
replaceProjectSharing- Required scopes
projects:sharing- SDK parameters
id: stringdata: ProjectSharingReplaceoptions: ProjectSharingMutationOptions- Path request fields
id: string- Header request fields
If-Match: string- Request body
ProjectSharingReplaceapplication/json- Success
200 ProjectSharing envelope
/projects/{id}/completeprojects.complete
Use this operation to complete a project asynchronously. The server validates the complete payload and derives workspace ownership from the authenticated credential. Required scopes, product permissions, sharing rules, workspace locks, and regional cell ownership are enforced for every request. Send the latest strong ETag in If-Match; stale revisions fail without overwriting a concurrent change. Use a stable Idempotency-Key when retrying so a transport timeout cannot create duplicate work.
client.projects.complete(id: string, options: ProjectLifecycleMutationOptions)- Return form
Promise- Operation ID
completeProject- Required scopes
projects:lifecycle- SDK parameters
id: stringoptions: ProjectLifecycleMutationOptions- Path request fields
id: string- Header request fields
If-Match: stringIdempotency-Key: string- Success
202 ProjectLifecycleOperation envelope
/projects/{id}/reopenprojects.reopen
Use this operation to reopen a project asynchronously. The server validates the complete payload and derives workspace ownership from the authenticated credential. Required scopes, product permissions, sharing rules, workspace locks, and regional cell ownership are enforced for every request. Send the latest strong ETag in If-Match; stale revisions fail without overwriting a concurrent change. Use a stable Idempotency-Key when retrying so a transport timeout cannot create duplicate work.
client.projects.reopen(id: string, options: ProjectLifecycleMutationOptions)- Return form
Promise- Operation ID
reopenProject- Required scopes
projects:lifecycle- SDK parameters
id: stringoptions: ProjectLifecycleMutationOptions- Path request fields
id: string- Header request fields
If-Match: stringIdempotency-Key: string- Success
202 ProjectLifecycleOperation envelope
/projects/{id}/archiveprojects.archive
Use this operation to archive a project asynchronously. The server validates the complete payload and derives workspace ownership from the authenticated credential. Required scopes, product permissions, sharing rules, workspace locks, and regional cell ownership are enforced for every request. Send the latest strong ETag in If-Match; stale revisions fail without overwriting a concurrent change. Use a stable Idempotency-Key when retrying so a transport timeout cannot create duplicate work.
client.projects.archive(id: string, options: ProjectLifecycleMutationOptions)- Return form
Promise- Operation ID
archiveProject- Required scopes
projects:lifecycle- SDK parameters
id: stringoptions: ProjectLifecycleMutationOptions- Path request fields
id: string- Header request fields
If-Match: stringIdempotency-Key: string- Success
202 ProjectLifecycleOperation envelope
/projects/{id}/restoreprojects.restore
Use this operation to restore a project asynchronously. The server validates the complete payload and derives workspace ownership from the authenticated credential. Required scopes, product permissions, sharing rules, workspace locks, and regional cell ownership are enforced for every request. Send the latest strong ETag in If-Match; stale revisions fail without overwriting a concurrent change. Use a stable Idempotency-Key when retrying so a transport timeout cannot create duplicate work.
client.projects.restore(id: string, options: ProjectLifecycleMutationOptions)- Return form
Promise- Operation ID
restoreProject- Required scopes
projects:lifecycle- SDK parameters
id: stringoptions: ProjectLifecycleMutationOptions- Path request fields
id: string- Header request fields
If-Match: stringIdempotency-Key: string- Success
202 ProjectLifecycleOperation envelope
Convenience helpers
These typed helpers compose mapped operations. They do not grant scopes or bypass API limits.
projects.pages
Iterate cursor pages with a bounded PaginationOptions policy.
client.projects.pages(options?: ProjectListOptions, pagination?: PaginationOptions)AsyncGeneratorErrors and transport metadata
HTTP failures reject with TeamGridApiError, including the status, stable error documents, request ID, optional retry delay, and transport metadata. Local validation, routing, timeout, response-size, and pagination failures reject withTeamGridClientError and a stable client error code. Successful envelopes expose non-enumerable transport metadata.
See pagination and errors andclient configuration for handling guidance.