Workfrontconnector v1.1

/attask/api/{version}/BILL

Create a new billing record for a project, optionally specifying description, amount, and status.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Version`	API version, e.g., v15.0
`Projectid`	The unique identifier of the project to associate with the billing record.
`Description`	A text description of the billing record.
`Otheramount`	The monetary amount for the billing record.
`Status`	The numeric status value for the billing record.
`Response Type`	The response format expected from the API (e.g. application/json).

/attask/api/{version}/bill/search

Retrieve a list of billing records, optionally filtered by project and with specific fields returned.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Version`	API version, e.g., v15.0
`Fields`	A comma-separated list of fields to include in the response.
`Projectid`	The unique identifier of the project to filter billing records by.
`Response Type`	The response format expected from the API (e.g. application/json).

/attask/{version}/CALEVT/search

Search for calendar entries based on criteria like date range, section, and external reference.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Version`	API version, e.g., v15.0
`Fields`	A comma-separated list of fields to include in the response.
`$$limit`	The maximum number of calendar entries to return.
`Calendarsectionid`	The unique identifier of the calendar section to filter entries by.
`Startdate`	The start date to filter calendar entries from.
`Startdate Mod`	The modifier for the start date filter, such as 'gte' or 'lte'.
`Extrefid Mod`	The modifier for the external reference ID filter.
`Response Type`	The response format expected from the API (e.g. application/json).

/fields=*&$$LIMIT=2000&calendarSectionID=600730e30269d86955b0d76b25d3ecf5&startDate=$$TODAY+14d&color=pink

Retrieve a test set of calendar entries with predefined filters, including all fields and a limit of 2000.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

/attask/{version}/CALEVT/{calevtId}

Update an existing calendar event by setting its external reference ID.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Version`	API version, e.g., v15.0
`Calevtid`	API version, e.g., v15.0
`Extrefid`	The new external reference ID for the calendar event.
`Response Type`	The response format expected from the API (e.g. application/json).

/attask/api/{version}/note

Adds a new note/comment to a given Workfront object.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Version`	API version, e.g., v15.0
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Notetext`	The text content of the note.
`Objid`	The unique identifier of the object to attach the note to.
`Noteobjcode`	The object code of the object to attach the note to.

/attask/api/{version}/note/search

Retrieves notes where entryDate is greater than the specified date.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Version`	API version, e.g., v15.0
`Entrydate`	The date and time to filter notes after (format: yyyy-MM-dd'T'HH:mm:ss:SSS-0000).
`Entrydate Mod`	The modifier for the entryDate filter (gt = greater than).
`Fields`	Comma-separated list of fields to return (e.g., ID,noteText,entryDate,objID,objCode,owner:emailAddr).
`Response Type`	The response format expected from the API (e.g. application/json).

/attask/api/{version}/{objectCode}/search

Retrieves the object specified by the ID query parameter, including all fields and parameterValues.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Version`	API version, e.g., v15.0
`Objectcode`	The object code (e.g., TASK, PROJ, USER)
`Id`	The unique identifier of the object to retrieve.
`Fields`	Comma-separated list of fields to retrieve. Use '*' for all fields.
`Response Type`	The response format expected from the API (e.g. application/json).

/attask/api/{version}/CTGY/search

Search for category parameters (custom form categories) by ID and return specified fields.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Version`	API version, e.g., v15.0
`Id`	The unique identifier of the category to retrieve.
`Fields`	A comma-separated list of fields to include in the response.
`Response Type`	The response format expected from the API (e.g. application/json).

/attask/api/{version}/ctgy/count

Get the total count of custom forms (categories) in the system.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Version`	API version, e.g., v15.0
`Response Type`	The response format expected from the API (e.g. application/json).

/attask/api/{version}/ctgy/search

Search for custom forms by name with an optional modifier and return specified fields.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Version`	API version, e.g., v15.0
`Fields`	A comma-separated list of fields to include in the response.
`Name`	The name of the custom form to search for.
`Name Mod`	The modifier for the name filter, such as 'eq' or 'contains'.
`Response Type`	The response format expected from the API (e.g. application/json).

/attask/api/{version}/param/count

Get the total count of parameters (custom form fields) in the system.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Version`	API version, e.g., v15.0
`Response Type`	The response format expected from the API (e.g. application/json).

/attask/api/{version}/POPT/search

Search for parameter options (dropdown choices) and return specified fields.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Version`	API version, e.g., v15.0
`Fields`	A comma-separated list of fields to include in the response.
`Response Type`	The response format expected from the API (e.g. application/json).

/attask/api/{version}/POPT/{id}

Update the display order of a parameter option.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Version`	API version, e.g., v15.0
`Id`	id
`Displayorder`	The new display order number for the parameter option.
`Response Type`	The response format expected from the API (e.g. application/json).

/attask/api/{version}/ctgy/{id}

Update the group associated with a custom form by setting its group ID.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Version`	API version, e.g., v15.0
`Id`	id
`Groupid`	The unique identifier of the group to assign to the custom form.
`Response Type`	The response format expected from the API (e.g. application/json).

/attask/api/{version}/cust/{custId}

Retrieve detailed information about a specific customer by its ID.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Version`	API version, e.g., v15.0
`Custid`	customer Id
`Response Type`	The response format expected from the API (e.g. application/json).

/attask/api/{version}/metadata

Retrieve metadata about the Workfront instance, such as available object types and fields.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Version`	API version, e.g., v15.0
`Response Type`	The response format expected from the API (e.g. application/json).

/internal/document/download

Still a work in progress.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Id`	The unique identifier of the document to download.
`Response Type`	The response format expected from the API (e.g. application/json).

/attask/api/{version}/docu/search

Search for documents by ID or project, and return specified fields.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Version`	API version, e.g., v15.0
`Id`	The unique identifier of the document to find.
`Projectid`	The unique identifier of the project to filter documents by.
`Fields`	A comma-separated list of fields to include in the response.
`Response Type`	The response format expected from the API (e.g. application/json).

/attask/api/{version}/DOCFDR/search

Search for document folders in the system.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Version`	API version, e.g., v15.0
`Projectid`	Filter by parent project ID.
`Name`	Filter by folder name (exact match behavior depends on server configuration).
`Fields`	Comma-separated list of fields to include in the response.
`Response Type`	The response format expected from the API (e.g. application/json).

/attask/api/{version}/docv/search

Search for versions of a specific document and return specified fields.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Version`	API version, e.g., v15.0
`Documentid`	The unique identifier of the document to retrieve versions for.
`Fields`	A comma-separated list of fields to include in the response.
`Response Type`	The response format expected from the API (e.g. application/json).

/attask/api/{version}/upload

Initiate a document upload by providing the file to upload.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Version`	API version, e.g., v15.0
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Uploadedfile`	The file content or reference to upload.

/attask/api/{version}/document

Upload a document to Workfront by providing the document's name, handle, and object code.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Version`	API version, e.g., v15.0
`Response Type`	The response format expected from the API (e.g. application/json).

Options (4)

Option Name	Description
`Name`	The name of the document being uploaded.
`Handle`	The handle or identifier for the document data.
`Docobjcode`	The object code for the document (e.g., "DOC" for documents).
`Objid`	The unique identifier of the object to attach the note to.

x-oneteg-downloader-path-with-authorization

Download an asset from a given URL with configurable timeout and retry settings.

Parameters

Parameter Name	Description
`HTTP Method`	The HTTP method to use for the download request.
`Download Url`	The URL from which to download the asset.
`Asset Name`	The name to assign to the downloaded asset.
`Try Count`	The number of download attempts to make before failing.
`Read Timeout (seconds)`	The maximum time in seconds to wait for data to be read.
`Connection Timeout (seconds)`	The maximum time in seconds to wait for a connection to be established.
`Load File Content As Output`	This toggle enables you to load file content as the step output. Supported formats include JSON, XML, YML/YAML, CSV, TXT, and other text-based file types. Note that images, PDF files, and other binary formats cannot be loaded. Additionally, there is a file size limit for this feature; please check the logs for details.
`Follow Redirects`	Enable or disable following URL redirects. If it is enabled, it will follow the URL redirects.
`headers`	Additional HTTP header name/value pairs to include in the request.

/attask/api/{version}/UIFT/search

Retrieve a list of all filters available in Workfront.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Version`	API version, e.g., v15.0
`Fields`	A comma-separated list of fields to include in the response.
`Response Type`	The response format expected from the API (e.g. application/json).

/attask/api/{version}/UIGB/search

Retrieve a list of all groupings available in Workfront.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Version`	API version, e.g., v15.0
`Fields`	A comma-separated list of fields to include in the response.
`Response Type`	The response format expected from the API (e.g. application/json).

/attask/api/{version}/UIVW/search

Retrieve a list of all views available in Workfront.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Version`	API version, e.g., v15.0
`Id`	The unique identifier of the document to find.
`Fields`	A comma-separated list of fields to include in the response.
`Response Type`	The response format expected from the API (e.g. application/json).

/attask/api/{version}/HOUR/search

Retrieve a list of hour entries logged in Workfront.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Version`	API version, e.g., v15.0
`Fields`	A comma-separated list of fields to include in the response.
`Response Type`	The response format expected from the API (e.g. application/json).

/attask/api/{version}/issue/{issueId}/convertToProject

Be sure to update the request body to set the conversion options and project values.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Version`	API version, e.g., v15.0
`Issueid`	id
`Updates`	A JSON string containing field updates for the new project.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Options`	An array of conversion options, such as "keepOriginal" or "includeAllTasks".

/attask/api/{version}/optask/search

Search for issues (tasks in the issue queue) using query parameters.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Version`	API version, e.g., v15.0
`Id`	The unique identifier of the document to find.
`Fields`	A comma-separated list of fields to include in the response.
`Response Type`	The response format expected from the API (e.g. application/json).

/attask/api/{version}/ASSGN

Update the assignment of an issue by specifying the issue ID and the new assignee.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Version`	API version, e.g., v15.0
`Optaskid`	The ID of the issue (opTask) whose assignment is being updated.
`Assignedtoid`	The ID of the user to assign the issue to.
`Response Type`	The response format expected from the API (e.g. application/json).

/attask/api/{version}/UITMPL/search

Search for layout templates using a search term.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Version`	API version, e.g., v15.0
`Name`	The name of the custom form to search for.
`T`	The search term to filter layout templates by name.
`Name Mod`	The modifier for the name filter, such as 'eq' or 'contains'.
`Response Type`	The response format expected from the API (e.g. application/json).

/attask/api/{version}/USER/search

Search for users in Workfront using query parameters.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Version`	API version, e.g., v15.0
`Id`	The unique identifier of the document to find.
`Fields`	A comma-separated list of fields to include in the response.
`Response Type`	The response format expected from the API (e.g. application/json).

/attask/api/{version}/{objectCode}

Update metadata fields on any object type by specifying the object code and the updates.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Version`	API version, e.g., v15.0
`Updates`	A JSON string containing the fields and values to update.
`Objectcode`	The object code representing the type of object to update (e.g., "PROJ" for project).
`Response Type`	The response format expected from the API (e.g. application/json).

/attask/api/{version}/UIVW

Create a new custom form with an ID view by providing view details and options.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Version`	API version, e.g., v15.0
`Updates`	A JSON string defining the view's properties and fields.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Options`	Additional options for creating the view, such as setting it as a default.

/attask/api/{version}/port/{portId}/share

Share a portfolio with a user or group by specifying their ID and object code.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Version`	API version, e.g., v15.0
`Portid`	portId
`Accessorid`	The ID of the user, group, or team to share the portfolio with.
`Accessorobjcode`	The object code of the accessor (e.g., "USER" for user, "GROUP" for group).
`Response Type`	The response format expected from the API (e.g. application/json).

/attask/{api}/{version}/project/{projectId}

Attach a template to an existing project, optionally specifying an action.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Api`	api
`Version`	API version, e.g., v15.0
`Projectid`	Project Id
`Action`	The action to perform when attaching the template, such as "attach" or "replace".
`Templateid`	The ID of the template to attach to the project.
`Response Type`	The response format expected from the API (e.g. application/json).

/attask/api/{version}/BLIN

Create a new baseline for a project, capturing a snapshot of the project's current state at a specific point in time. Use this to save project progress for future comparison or rollback.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Version`	API version, e.g., v15.0
`Updates`	A JSON string defining the view's properties and fields.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (5)

Option Name	Description
`Objcode`	The object code of the baseline object, typically 'BLIN'.
`Id`	An optional ID to assign to the new baseline; if omitted, Workfront generates one.
`Projectid`	The ID of the project for which to create the baseline.
`Name`	The name of the document being uploaded.
`Isdefault`	Set to true to make this baseline the default for the project.

/attask/api/{version}/project

Create a new project from a predefined template, optionally setting the initial project status. Use this to quickly spin up projects using a standardized structure.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Version`	API version, e.g., v15.0
`Name`	The name of the custom form to search for.
`Templateid`	The ID of the template to attach to the project.
`Status`	The initial status of the new project, such as 'CUR' for Current or 'PLN' for Planning.
`Response Type`	The response format expected from the API (e.g. application/json).

/attask/api/{version}/ASSGN/search

Retrieve assignment hours by searching the ASSGN object. Use this to get the hours logged against assignments that match specified criteria.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Version`	API version, e.g., v15.0
`Projectid`	The unique identifier of the project to filter documents by.
`Fields`	A comma-separated list of fields to include in the response.
`Response Type`	The response format expected from the API (e.g. application/json).

/attask/api/{version}/ASSGN/report

Generate a report of assignment hours with aggregate functions applied. Use this to obtain summarized hours data, such as totals or averages, across assignments.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Version`	API version, e.g., v15.0
`Projectid`	The unique identifier of the project to filter documents by.
`Fields`	A comma-separated list of fields to include in the response.
`Work Aggfunc`	The aggregate function to apply to the work hours field, for example 'SUM' or 'AVG'.
`Response Type`	The response format expected from the API (e.g. application/json).

/attask/api/{version}/BSTSK/search

Search for baseline tasks (BSTSK) associated with a specific baseline. Use this to retrieve the tasks captured in a particular baseline snapshot.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Version`	API version, e.g., v15.0
`Baselineid`	The ID of the baseline whose tasks you want to retrieve.
`Response Type`	The response format expected from the API (e.g. application/json).

/attask/api/{version}/project/metadata

Get metadata for a project, including custom forms, fields, and other configuration details. Use this to inspect the structure and settings of a project without loading its full data.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Version`	API version, e.g., v15.0
`Response Type`	The response format expected from the API (e.g. application/json).

/attask/api/{version}/proj/search

Search for projects using various criteria, including status. Use this to find projects that match specific conditions such as being in a particular state.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Version`	API version, e.g., v15.0
`Id`	The unique identifier of the document to find.
`Fields`	A comma-separated list of fields to include in the response.
`Status`	Filter projects by their status code, for example 'CUR' for Current or 'CPL' for Complete.
`Response Type`	The response format expected from the API (e.g. application/json).

/attask/api/{version}/{objCode}/{projectID}

Recalculate the timeline of a project, updating dates, durations, and dependencies. Use this after making changes that affect the project schedule to ensure accuracy.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Version`	API version, e.g., v15.0
`Objcode`	Project object code PROJ
`Projectid`	id
`Action`	The action to perform when attaching the template, such as "attach" or "replace".
`Response Type`	The response format expected from the API (e.g. application/json).

/attask/api/{version}/BLIN/search

Search for baselines across all projects. Use this to find existing baseline snapshots based on criteria such as project ID or baseline name.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Version`	API version, e.g., v15.0
`Projectid`	The unique identifier of the project to filter documents by.
`Fields`	A comma-separated list of fields to include in the response.
`Response Type`	The response format expected from the API (e.g. application/json).

/attask/api/{version}/project/{projectId}

Update an existing project's fields, such as its URL or other attributes. Use this to modify project information after creation.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Version`	API version, e.g., v15.0
`Projectid`	The ID of the project to update.
`Url`	The new URL value to set on the project.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Id`	Unique identifier for the asset or record

/attask/api/{version}/QUET/search

Retrieve queue topics for a specific queue definition (project). Use this to list the topics available in a request queue.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Version`	API version, e.g., v15.0
`Name`	The name of the custom form to search for.
`Queuedef:projectid`	The ID of the project that contains the queue definition whose topics you want to fetch.
`Response Type`	The response format expected from the API (e.g. application/json).

/attask/api/{version}PTLSEC/search

Search for reports based on the user who entered them. Use this to find reports created or modified by a specific person.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Version`	API version, e.g., v15.0
`Fields`	A comma-separated list of fields to include in the response.
`Enteredby:name`	The name of the user who entered the report.
`Enteredby:name Mod`	The modifier for the entered-by name filter, such as 'equal' or 'contains'.
`Response Type`	The response format expected from the API (e.g. application/json).

/attask/api/{version}/acslvl/search

Search for access levels in the system. Use this to retrieve access level definitions and their settings.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Version`	API version, e.g., v15.0
`Name`	The name of the custom form to search for.
`Fields`	A comma-separated list of fields to include in the response.
`Response Type`	The response format expected from the API (e.g. application/json).

/attask/api/{version}/GROUP/search

Search for groups in Workfront. Use this to find groups by name or other criteria.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Version`	API version, e.g., v15.0
`Fields`	A comma-separated list of fields to include in the response.
`Response Type`	The response format expected from the API (e.g. application/json).

/attask/api/{version}/category/assignCategory

Assign a custom form to a task, linking the form to the object. Use this to attach additional data fields to a task.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Version`	API version, e.g., v15.0
`Objid`	The ID of the task to which the form will be assigned.
`Objcode`	The object code of the task, typically 'TASK'.
`Categoryid`	The ID of the custom form (category) to assign.
`Sessionid`	The session ID for authentication, required to perform the assignment.
`Response Type`	The response format expected from the API (e.g. application/json).

/attask/api/{version}/task

Create a new task in Workfront. Use this to add a task with optional parent and predecessor expression.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Version`	API version, e.g., v15.0
`Projectid`	The unique identifier of the project to filter documents by.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Name`	The name of the document being uploaded.
`Parentid`	The ID of the parent task or project under which the new task is created.
`Predecessorexpression`	A string expression defining predecessor dependencies for the task.

/attask/api/{version}/task/{taskId}

Permanently delete a specific task by its ID. Use this to remove a task from Workfront.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Version`	API version, e.g., v15.0
`Taskid`	Task Id
`Response Type`	The response format expected from the API (e.g. application/json).

/attask/api/{version}/TASK/{taskId}

Retrieve details of a single task by its ID. Use this to get task fields and metadata.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Version`	API version, e.g., v15.0
`Fields`	A comma-separated list of fields to include in the response.
`Taskid`	The unique identifier of the task to retrieve.
`Response Type`	The response format expected from the API (e.g. application/json).

/internal/customform/data

Retrieve custom form data values for tasks. Use this to get the values of custom fields associated with tasks.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Accept`	The media type expected in the response, such as application/json.
`Sessionid`	The session ID for authentication, required to perform the assignment.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (4)

Option Name	Description
`Objid`	The unique identifier of the object to attach the note to.
`Objcode`	The object code of the baseline object, typically 'BLIN'.
`Categoryids`	An array of category IDs whose custom form data to retrieve.
`Withdefaultvalues`	Whether to include default values for custom fields.

/attask/api/{version}/TASK/search

Search for tasks based on custom field values. Use this to find tasks matching a specific page ID.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Version`	API version, e.g., v15.0
`Fields`	A comma-separated list of fields to include in the response.
`De:pageid`	The custom field value for pageID to search for.
`Projectid`	The unique identifier of the project to filter documents by.
`Response Type`	The response format expected from the API (e.g. application/json).

/attask/api/{version}/TASK/{taskId}

Update an existing task's fields. Use this to modify task properties like status, name, or custom data.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Version`	The version number of the task object for optimistic locking.
`Taskid`	The unique identifier of the task to update.
`Response Type`	The response format expected from the API (e.g. application/json).

/attask/api/{version}/TEAMOB/count

Retrieve the count of team objects that match search criteria. Use this to get the number of teams without fetching full details.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Version`	API version, e.g., v15.0
`Name`	The name of the custom form to search for.
`Name Mod`	The modifier for the name filter, such as 'eq' or 'contains'.
`Response Type`	The response format expected from the API (e.g. application/json).

/attask/api/{version}/TMPL/search

Search for project templates based on query parameters. Use this to find templates matching specific criteria.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Version`	API version, e.g., v15.0
`Id`	The unique identifier of the document to find.
`Response Type`	The response format expected from the API (e.g. application/json).

/attask/api/{version}/USER/count

Get the count of users filtered by active status. Use this to determine how many active or inactive users exist.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Version`	API version, e.g., v15.0
`Isactive`	Boolean indicating whether to count only active users (true) or inactive users (false).
`Response Type`	The response format expected from the API (e.g. application/json).

/attask/api/{version}/user

Create a new user in Workfront with optional profile and access settings. Use this to provision a user account.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Version`	API version, e.g., v15.0
`Updates`	A JSON string defining the view's properties and fields.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (12)

Option Name	Description
`Emailaddr`	The email address for the new user.
`Firstname`	The user's first name.
`Lastname`	The user's last name.
`Homegroupid`	The ID of the home group for the user.
`Isactive`	Whether the user account is active.
`Password`	The initial password for the user.
`Ssoaccessonly`	Whether the user can only access via SSO.
`Username`	The unique username for the user.
`Accesslevelid`	The ID of the access level to assign.
`Companyid`	The ID of the company the user belongs to.
`Extrefid`	An external reference ID for the user.
`Managerid`	The ID of the user's manager.

/attask/api/{version}/user

Delete a user from Workfront. Use this to remove a user account, optionally forcing deletion even if the user has records.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Version`	API version, e.g., v15.0
`Id`	The unique identifier of the document to find.
`Force`	Boolean indicating whether to force deletion despite existing data references.
`Response Type`	The response format expected from the API (e.g. application/json).

/attask/api/{version}/cust/search

Search for custom environment configurations. Use this to verify environment settings or retrieve custom data.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Version`	API version, e.g., v15.0
`Response Type`	The response format expected from the API (e.g. application/json).

/attask/api/{version}/user

Generate a new API key for a user by providing credentials. Use this to obtain an API key for programmatic access.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Version`	API version, e.g., v15.0
`Action`	The action to perform when attaching the template, such as "attach" or "replace".
`Username`	The username of the user to generate the API key for.
`Password`	The password of the user.
`Response Type`	The response format expected from the API (e.g. application/json).

/attask/api/{version}/login

Authenticate a user and obtain a session token. Use this to log in and receive credentials for subsequent API calls.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Version`	API version, e.g., v15.0
`Username`	The username to log in with.
`Password`	The password for the user.
`Response Type`	The response format expected from the API (e.g. application/json).

/attask/api/{version}/PROJ/count

Count the number of projects that match the specified filters, such as portfolio ID or status.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Version`	API version, e.g., v15.0
`Portfolioid Mod`	Filter projects by a specific portfolio ID using a modifier.
`Status`	Filter projects by their status code, for example 'CUR' for Current or 'CPL' for Complete.
`Status Mod`	Filter projects by a specific status using a modifier.
`Fields`	A comma-separated list of fields to include in the response.
`$$limit`	The maximum number of calendar entries to return.
`$$first`	Specify the starting index for pagination to return a subset of results.
`Response Type`	The response format expected from the API (e.g. application/json).

/attask/api/{version}/user/{userId}

Update an existing user's information, such as their access level.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Version`	API version, e.g., v15.0
`Userid`	API version, e.g., v15.0
`Accesslevelid`	The ID of the new access level to assign to the user.
`Response Type`	The response format expected from the API (e.g. application/json).

/attask/eventsubscription/api/v1/subscriptions

Create a new webhook subscription to receive event notifications from Workfront.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (4)

Option Name	Description
`Objcode`	The object code of the baseline object, typically 'BLIN'.
`Eventtype`	The type of event that triggers the webhook notification.
`Url`	The URL where the webhook payload will be sent.
`Authtoken`	An optional authentication token to include in the webhook request.

/attask/eventsubscription/api/v1/subscriptions/{id}

Delete an existing webhook subscription by its unique identifier.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Id`	The unique identifier of the webhook subscription to delete.
`Content-type`	The content type of the request, typically application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

/attask/eventsubscription/api/v1/subscriptions/list

Retrieve a list of all existing webhook subscriptions.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Content-type`	The content type of the request, typically application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

Billing Records (2)

Calendar Entry (3)

General (3)

Custom Forms (7)

Customer Data (2)

Documents (6)

Download

Filters, Views, and Groupings (3)

Hours

Issues (3)

Layout Templates

Misc (2)

New User Setup

Portfolio

Projects (11)

Queues

Reports and Dashboards

Setup (2)

Tasks (7)

Teams

Templates

Users (8)

Webhooks (3)