Workfront API to find Project by Reference Number

Question

Hi everyone, Is it possible to use the Workfront API to search/add to an existing project using the Ref # and how would that be structured in the URL? Thank you,Shane

ChrisStephens · Accepted Answer

You have to modify a project with the UID of the project, but you can for sure search for a project with the reference number, just add referenceNumber={your reference number} to your query string, replacing {your reference number} with the target reference number.

cverges · Answer

Do you mean the External Reference ID? If so, it would be an API query that would just filter on that. You can either use the regular Search module or a Custom API module. The query parameter would be extRefID and the value would just be the value you'd want. You can also use the regular _Mod modifiers. (I've found https://github.com/Workfront/workfront-api-constants/blob/master/src/constants.ts to be a really useful resource for seeing those.)

Example query set:

extRefID_Mod=cicontains
extRefID=SomeSubstringValue

Setting would just be updating the same object to have an extRefID value.

Hope that helps!

Sign up

Login with SSO

Login to the community

Login with SSO