The awork Github repo supports you with awork integration and api questions. Here you can find links to further documentation, a FAQ with the most frequently asked questions and great code examples to get started even faster.
Home Page: https://www.awork.com
Your documentation describes the comments or activities can be read with "/entityName/entityId/comments". I don´t know where i can find the "entityName". The debugger only shows the "entityId".
Code (from Google-Sheet):
Thanks in advance.
Dear awork team,
I'd like to use projecttasks endpoints to prepare a custom dashboard for a client. However, different from project level data where I've sucessfully managed to generate a google sheet dashboard, a generic API key doesn't seem to work.
What kind of authorization can I use to access the data - ideally through google scripts - so that clients can see the dashboard/table but don't get access to the full data detail?
Thanks and regards,
Hendrik
It seems you are using an (undocumented) 'orderBy' query parameter in your frontend. Is this orderBy option widely supported by your API or limited to certain endpoints?
It seems to be a good fit to be used with your filtering and and pagination options.
Is there any reason this is undocumented territory?
No response
Currently, when you are using the endpoint to update a task (PUT /tasks/{entityId}) all values which are omitted in the request are treated as if they are present but empty.
Example:
GET /tasks/{entityId} (I left out some response data)
{
"id": "e230d4d0-2691-eb11-a607-00155d314496",
"plannedDuration": 28800,
"name": "Test task",
"isPrio": false,
"dueOn": "2021-03-31T16:00:00Z"
}
PUT /tasks/{entityId}
{
"plannedDuration": 28800,
}
☝ this throws a validation error that "Name" is required even though I don't want to change it.
PUT /tasks/{entityId}
{
"name": "Test task",
"plannedDuration": 28800,
}
This works, but if i now GET the task again this is the response:
{
"id": "e230d4d0-2691-eb11-a607-00155d314496",
"plannedDuration": 21600,
"name": "Test task",
"isPrio": false
}
It is missing dueOn because it was unset during the PUT request. To mitigate this issue we are getting the task data and sending the whole payload back to the API after we changed the relevant fields. Since this happens in a queue system there could be possible race conditions of the task get's updated by a user in the meantime.
Is there some way to tell the API to just update the fields which are sent with the request?
Hello
I was testing your API via postmen. I want to add the phone, email and URL fields to the endpoint but its not been added.
This is the JSON data I am sending.
I am getting blank "companyContactInfo" array in response and also data is not populating in the account
What is the JSON structure of the request? An example will be helpful
Awaiting your response.
Regards
Hi there,
I noticed that entity types have a property "key", which are auto-generated based on a unique abbreviation of the entity's name. A new project "Foo Bar" becomes key "FB", and the first task of this project becomes key "FB-1".
Where and how is it currently used by the SPA?
Now I wonder whether we can use this information instead of the UUID/URL for (cross-)referencing tasks in other systems and in communication, like issue numbers are used in ticket/issue systems.
My concrete questions:
I want to use your API and make a program for our company.
https://api.awork.io/api/v1/projects this api end point wWhich I am using,
but I can not find in this API end point answer for the below question?
Which user how much time work on this project? Can you add this to this API end point?
To better understand my question. I add a picture for my project.
`
No response
Really interesting
Hi,
I created new projects with the project template via API. The project itself works. Now I have to edit the tasks as well as via API . How do I search for the task name? /projects/{projectId}/....?
Hope to hear from you soon
Beverly
Hello, i am trying to filter API requests, but none of them works
users
returns all users
users?filterby=FirstName eq 'Thomas'
returns NULL
and it is the same for timeEntries ...
could someone help me?
Thanks in advance.
Thomas
No response
Hey, lately I've been accessing the API wit OAuth 2, which is expiring in a short time, I would like to use the API with a fixed Access Token, in the Docs there's a link which is explaining the details https://support.awork.io/hc/de/articles/360002815960-Client-Applications-und-API-Keys but it's not working, so how can we do that?
Thanks
Hi,
I created 2 new tags with
POST
/tasks/{entityId}/addtags
[
{
"name": "Tag1",
"color": "blue"
}
,
{
"name": "Tag2",
"color": "purple"
}
]
If the value of Tag2 is zero, the tag should not be created.
Hope to hear from you soon
Beverly
Hi 👋🏻
We are creating projects via the API and one of my colleagues reported that after creation the project description is missing.
This doesn't happen all the time but it's not the first time I got a report like this.
But! This time I have a trace id :-)
2280233ae9839987 or
2628fddf632b2dcb
It's possibly the first one but I'm not completely sure since they are not one second apart.
Hi,
I created 4 new tags with
POST
/tasks/{entityId}/addtags
[
{
"name": "Tag1",
"color": "kblue"
}
,
{
"name": "Tag2",
"color": "purple"
}
,
{
"name": "Tag3",
"color": "yellow"
}
,
{
"name": "Tag4",
"color": "red"
}
]
Unfortunately, the tags are not added to the task in that order. The order there is
Tag3, Tag4, Tag1, Tag2
It is possible to determine the order?
On this occasion, can you tell me the colors available?
Hope to hear from you soon
Beverly
Hi Awork Team
I wanted to get compony Logo from api. But I can't find from documentation. There is no Company Logo in this end point.
https://openapi.awork.io/#/Companies/get_companies
No response
Hallo,
ich habe eine Frage zur Datenabfrage über die API von awork.
Wir ziehen uns Daten zu den Projekten aus awork. Das funktioniert mit der URL: https://api.awork.io/api/v1/projects und dem hinterlegten API-key.
Nun möchte ich auch auf die Benutzerdaten, Daten zu Aufgaben und Daten zu hinterlegten Einstellungen zugreifen.
Wie komme ich an diese Daten ran?
MfG Tom Schäfer
No response
When I create a ticket using the REST API, the links in a ticket are not displayed correctly. However, as soon as I put the focus on the description field, the links are displayed correctly. Email links (i.e. mailto:) are always displayed correctly.
Unfocused links:
Focused links:
No response
As mentioned previously in conversation with @nilzzzzzz we were developing a JavaScript wrapper for the Awork REST API for internal use.
After some final code cleanup, we decided to open source the wrapper.
If you are interested, have a look: https://www.npmjs.com/package/@brandboostinggmbh/awork-sdk
No response
Im currently testing out the API and tried to create a Task. The Server returned this:
{ "code": "server-error", "description": "Oops, something went wrong. Try repeating the request. If it still fails, visit our developer portal for help at https://developers.awork.io. Provide the 'trace-id' from the response header so that we can help you best.", "space": "Space isn't remote at all. It's only an hour's drive away, if your car could go straight upwards. — Sir Fred Hoyle, Astronomer" }
I would like to know where exactly the error is. Someone from the Support said here is the right Place to ask.
Here is my trace-id: 26cbce0b52aa88f1
It would also be a good Idea to change the link in the error request since you cannot get any help over there.
We are currently developing an Interface to an external billing tool. Is it possible to mark time entries as "transferred" to the external tool, maybe via custom fields for time entries?
No response
Hallo Ihr Lieben,
ich habe über Eure tolle API und anhand des von Euch bereitgestellten Beispiel-Codes eine awork Anbindung für Google Sheets realisiert.
Nun gibt es noch einige spezielle Anforderungen, die ich leider nicht gelöst bekommen und freue mich, wenn Ihr hier unterstützen könnt.
Tags eines Projektes in eine Spalte schreiben
-> über welche Variable kann ich die Tags auslesen?
-> schaut gerne mal im anhängenden Screenshot, was ich meine (so klappt es leider nicht)
für jedes Projekt das Startdatum der Aufgabe "Projektstart" auslesen und dieses in eine Spalte schreiben
-> hier arbeite ich derzeit noch mit einem Code-Schnipsel von Euch, mittels dessen ich die früheste Aufgabe auslesen kann und damit sozusagen den Projektstart auslesen kann (siehe hier: #8)
-> leider klappt das nicht, da manche Aufgaben einfach vor Projektstart beginnen (ja, klingt komisch)
-> jetzt möchten wir den Projektstart gerne in der Aufgabe "Projektstart" hinterlegen und dann für jedes Projekt auslesen
Könnt Ihr mich hier bitte mit einem Code unterstützen?
Vielen vielen Dank vorab für Eure Bemühungen.
Liebe Grüße,
Martin
Änderungen ohne jegliche Hilfsmittel in Artwork-API
trace-id: 2ab931e5606e3ccd
Hey Awork,
I didn't find any way in the documentation to create a new task in Team Planner via the API, can somebody help please?
Best regards
It seems like the API does not allow ApiUsers to read the list of users at /users.
In the docs user-master-data permission is mentioned, not sure how to add permissions to ApiUsers.
No trace id was returned.
{ data: { message: { code: 'unauthorized', description: 'Unauthorized' } }, status: 401, statusText: 'Unauthorized', headers: { 'content-type': 'application/json; charset=utf-8', 'content-length': '64' }, config: { url: '/users', method: 'get', headers: {}, params: {}, baseURL: 'https://api.awork.io/api/v1', transformRequest: [ [Function: transformRequest] ], transformResponse: [ [Function: transformResponse] ], timeout: 0, adapter: [Function: xhrAdapter], xsrfCookieName: 'XSRF-TOKEN', xsrfHeaderName: 'X-XSRF-TOKEN', maxContentLength: -1, maxBodyLength: -1, validateStatus: [Function: validateStatus], data: undefined }, request: XMLHttpRequest {} }
No response
Hello, I am currently looking into using these two endpoints:
/me/assignedtasks/me/allavailabletasksaccording to your API specification the /me/allavailabletasks endpoint returns:
Whereas the /me/assignedtasks endpoint returns "all assigned tasks" (including private).
According to that logic the /me/allavailabletasks endpoint should return at least the same amount of tasks, if not more, than the /me/assignedtasks endpoint. But for us this is not the case.
But when using both calls with the same user, the /me/allavailabletasks does not return all assigned tasks that I get with /me/assignedtasks.
Is there a possibility to transfer a negative remaining duration to the endpoint (PUT) /tasks/{taskId} (Updates the task with the specified id.)?
We send negative durations but in the tasks view the value is zero for the remaining duration.
No response
Hi Awork,
I created a webhook from your endpoint but It is not triggered my end point.
this is the webhook which I created.
[
{
"id": "cfcd3772-fb79-ec11-94f6-dc984040d6c7",
"receiverType": "custom",
"createdOn": "2022-01-20T14:15:50.7773576",
"createdBy": "133eff6f-f372-ec11-94f6-dc984040d6c7",
"updatedOn": "2022-01-20T14:15:50.7773642",
"updatedBy": "133eff6f-f372-ec11-94f6-dc984040d6c7",
"name": "NotifyProjectAndTimeEntryAddedUpdated",
"uri": "https://fd-project-api.azurewebsites.net/api/WebHook/WebHookFromAwork",
"language": "en-US",
"events": "project_added,project_deleted,project_status_changed,project_type_changed,project_updated,timetracking_added,timetracking_deleted,timetracking_type_changed,timetracking_updated",
"isActive": true,
"authenticationType": "none"
}
]
If I edit or add time entry, my end point(GET) is not triggered.
I solved the Problem. it must be post :))
No response
Hi Awork,
I hav egot some issues.
1-)https://api.awork.io/api/v1/projects/47c69c59-1c93-ec11-a22a-38563d684e0e/tags in this end point coming a lot of tags but in system. only 5 Tags.
2-)Second bug is-->I am trying to delete Tags
https://api.awork.io/api/v1/projects/47c69c59-1c93-ec11-a22a-38563d684e0e/deletetags
[
{
"name": "Prio_Gold",
"entityId": "47c69c59-1c93-ec11-a22a-38563d684e0e"
},
{
"name": "Prio_High",
"entityId": "47c69c59-1c93-ec11-a22a-38563d684e0e"
},
{
"name": "Prio_Low",
"entityId": "47c69c59-1c93-ec11-a22a-38563d684e0e"
},
{
"name": "Prio_Standard",
"entityId": "47c69c59-1c93-ec11-a22a-38563d684e0e"
},
{
"name": "Status_Hold",
"entityId": "47c69c59-1c93-ec11-a22a-38563d684e0e"
}
]
and I am getting an error-->TraceID:2541af3389cc0b9c
Thank you for Your help,
Best regards,
Yusuf Baskaya
TraceID:2541af3389cc0b9c
No response
Hallo zusammen,
der erste Versuch via google sheets ist kläglich gescheitert und im Grunde auch keine Option da wir google sheets im Unternehmen nicht einsetzen.
Gibt es eine Möglichkeit mal einen Telefontermin zu organisieren bei dem ihr unterstützen könnt?
Was will ich eigentlich:
Mittels der Exportfunktion im Projektbereich erhalte ich nicht die Start und Enddaten der Projekte, die benötige ich aber für meine Auswertung (Controlling). Ich sehe aktuell keine andere Möglichkeit als über die API, außer der Standard-Export wird "erweitert". API mäßig bin ich wissensmäßig auf null.
Meine Frage hatte ich bereits im Helpcenter platziert und wurde dann an Euch als Entwickler verwiesen.
Danke für eure Hilfe,
Jens (emetriq GmbH)
No response
What is the meaning of the entityId of a tag object? I'm not sure because the /tags endpoint is hardly documented.
Is it the first entity object, this tag was assigned to? Because I tested to add the tag to other entities and nothing changed with the entityId. Shouldn't it rather be an array of all entity Ids, this tag is assigned to or am I missing something here?
There seems to be missmatching descriptions in the OpenAPI Doc at "team POST/PUT model".
We are currently using a 14-days trial version workspace as substitute for a sandbox environment (coral-incredible-stars.awork.io) for our automated JEST tests. This is a little hideous though, as we have to create a new account every ~14 days.
Is there any kind of sandbox or testing environment that we could use for our continuous testing?
Is there any reason the /webhooks Endpoints are undocumented?
/projects/{projectId}/addprojectmember
Hi I've been trying all day to add an employee to a project via the API. Unfortunately, every time I get the answer "null".
If I try the whole thing via the DOC it doesn't work either.
{
"userId": "ID from the USER",
"projectRoleId": "ID from the ROLE",
"isResponsible": false
}
Best regards,
Patrick
No response
Hello, I have some issues with the '/users' endpoint of the api. I have the feeling this is an internal error because I tried POST and GET requests and both won't work.
For example this is the error response of a POST request:
{ code: 'validation-failed', description: 'The model sent in the request is invalid. See the validation errors for details.', link: 'https://developers.awork.io/', space: 'Uranus’ blue glow is down to the methane in its atmosphere, which filters out all the red light.', validationErrors: [ { property: '$.accountId', message: 'The JSON value could not be converted to System.Guid. Path: $.accountId | LineNumber: 0 | BytePositionInLine: 196.' } ] }
Here is my trace id: '57e7e231eb8c7ec5'.
Hi,
I create new projects with the project template with automations via API. The project is okay. But the automations are unfortunately added 17 times to the project. What could be the mistake?
Thanks for a help
Beverly
The task was created, but no user is assigned. How can i set this?
Thanks in advance.
We are currently writing an integration which will use the webhooks from awork.
Unfortunately we are seeing errors (status code 400 sent by our server, apparently) for which we can't find logs on our side. To better debug this it would be of great help if the log would provide at least the server message sent with the response, better yet: the complete response object.
Another thing I've found: testing webhooks from the UI always triggers a 405 Method Not Allowed. It seems like the test functionality does not use a POST request?
If possible it would also be great if we could choose which event to test, this would greatly reduce errors because of typos in the event name.
Thanks up front :)
No response
Hello. I'm currently trying to get all time entries whose start date lies within a certain time range. I've currently managed to retrieve all time entries without using filters, but when trying to filter with startDateUtc, all entries are retrieved again, as if there were no filter applied.
I am using SoapUI to test the endpoint using the following URL:
and as well:
https://chartreuse-singular-idols.awork.io/api/v1/timeentries?startDateUtc=2022-03-03T00%3A00%3A00.000Z
The following trace-id were generated after the calls:
First Call:
trace-id: 2c40f4a807c2147c
Second call:
trace-id: 2aad67a29acf17bb
I understand that I might not be filtering properly. In that case, how can I apply the filter mentioned beforehand?
Thank you very much.
trace-id: 2c40f4a807c2147c
trace-id: 2aad67a29acf17bb
Hi awork,
we are currently trying to get the login timestamp as seen in the time-entries view.
It seems, this info is available under the endpoint /me/stats/workhours?date=.... If I try to access this endpoint from our client application I unfortunately get the error "No permissions to access this endpoint.".
Would it be possible to access this endpoint from a client application? If possible it would be great if this was accessible under the User ressource so we can query this data for every user.
Thanks up front :)
No response
Creating a project with a valid projectTemplateId with the endpoint POST /projects should result in the task statuses from the template being populated in the newly created project.
We create a new project with the following payload:
{
"name": "Project name",
"projectTypeId": "valid-project-type-id",
"projectStatusId": "valid-project-status-id",
"projectTemplateId": "valid-project-template-id",
"isBillableByDefault": true
}
The project is correctly created but all task statuses defined are missing.
This results in the following error when trying to create a new task:
{"code":"validation-failed","description":"The model sent in the request is invalid. See the validation errors for details.","link":"https://developers.awork.io/","space":"The Martian day is 24 hours 39 minutes and 35 seconds.","validationErrors":[{"property":"$.taskStatusId","message":"The JSON value could not be converted to System.Guid. Path: $.taskStatusId | LineNumber: 0 | BytePositionInLine: 74."}]}
I don't see any calls to other endpoints from awork itself to create the task statuses when creating a project to I'm assuming something's wrong with our payload preventing the creation of the task statuses?
No trace-id was being issued.
No response
The /timeentries endpoints returns only 1000 records. How to get more?
No response
Hallo Ihr Lieben,
ich verknüpfe awork derzeit mit unseren Google Tabellen.
Dabei würde ich über das Google Script gerne auslesen, welches die Aufgabe mit dem frühesten Startdatum des Projektes ist und wann das Startdatum ist. Das ist für unsere Finanzplanung extrem wichtig.
Alternativ könnte ich vielleicht auch in jedem Projekt eine Aufgabe "Startdatum" anlegen und dann das Startdatum dieser Aufgabe gezielt für jedes Projekt auslesen und in die Google Tabelle schreiben...
Nur leider bekomme ich den Code nicht auf die Kette und freue mich sehr, wenn Ihr hier unterstützen könnt.
Über welche Variable / welchen Script-Code bei Google kann ich das machen?
Gibt es weiterhin ein Möglichkeit abgerechnete und nicht abgerechnete Stunden auszulesen?
Vielen vielen Dank für Eure Hilfe und liebe Grüße,
Martin
Hi awork 👋
We are currently trying to implement a way to complete a project task via the api.
What is the best way to achieve this? I understood that every project has it's own task statuses, therefore it is not possible to just store the done-id as a const somewhere, right?
Using /project/entityId as endpoint I don't get the statuses of a task. I found the (undocumented?) endpoint /project/entityId/tasktstatuses which gives me all statuses.
I'd try the following, would be great to hear if I missed some "shortcut"
/project/entityId/taskstatusesdone (for simplicity I'll assume we only have one per type or just use the first one)/tasks/entityId/Thanks in advance :)
Hallo,
ich benötige Unterstützung bei der API /timeentries Filterfunktion. Ziel ist es mittels der Filterfunktion die Zeiteinträge einzelner Projekte zu betrachten. Der Filter funktioniert bei int, boolean und teilweise Strings. Bei Id's und Datetime erscheint jedoch die Message: "invalid-filter-or-order", "Something is wrong with the given 'filterby' expression.".
Erfolgreich: /timeentries?filterby=note%20eq%20%27Testbeschreibung%27
Fehler: /timeentries?filterby=projectId%20eq%20%27000f215e-xxxx-ec11-xxxx-38563d6e4a56%27
Die Trace-ID für den Projekt-Filter lautet „248307f30689ca81“.
Vielen Dank im Voraus.
JanLue
248307f30689ca81
Hi,
how can I activate the autopilot of a project via API? Preferably directly in the waterfall mode.
Beverly
I use timewarrior [1] as my personal time tracking tool. It works better for me than having to remember using a website. I want to sync my own timetracking with awork. So I would like to write to my own account. Ideally automated. For this I need to use some form of authentication. Your docs [2] you use OAuth2 ,maybe a fixed token works as well but that is unclear from the text. However I cannot create the neseccary client. Everytime I try to I get a 401 error. See attached screenshot. The exact error is POST https://lawngreen-exotic-foxes.awork.io/api/v1/clientapplications 401 (Unauthorized)
I assume I'm still lacking some permissions to create client an generate an API key.
What permissions would I need to create a client?
Or alternatively how can I get a token with read/write access to my user only (Similar to the way todoist or gitlab handle this)?
[1] http://timewarrior.net/
[2] https://support.awork.io/hc/en-us/articles/360002815960-Client-Applications-and-API-Keys
I generated a new API key as explained here: https://support.awork.io/en/articles/5415664-client-applications-and-api-keys (see also #13)
However, I miss an example using my client-id and client-secret without OAuth2 auth, as explained here: https://developers.awork.io/authentication
You have two options to access our api.
- Fixed token generated in the ui which is permanent valid, but is not user specific. This makes sense for background synchronisation applications. Details explained here.
- OAuth 2
Could you please provide a simple example how to access the API without any user relation?
Hallo,
ich bekomme zu /timeentries nur die letzten 1000 Datensätze von awork ausgegeben.
Ist es möglich alle Buchungen zu bekommen.
Habe versucht verschiedene Filter zu setzten, leider bekomme ich dann gar nichts mehr als Antwort zurück.
Z.B.
/timeentries?filterby=endDateLocal le datetime'2022-04-01T00:00'
müsste, laut Anleitung von https://developers.awork.io/filtering, funktionieren. Tut es aber nicht.
Wie muss die URL aussehen damit ich einen funktionierenden Filter auf createdOn mit einem von - bis Datumsbereich habe.
wie zum Beispiel:
https://api.awork.io/api/v1/timeentries?filterby=createdOn ge datetime'2022-01-01T00:00 le datetime'2022-01-31T00:00'
oder
https://awork.io/api/v1/timeentries?filterby=substringof('2022-01',createdOn)
Bitte dringend um Hilfe.
Mit freundlichen Grüßen
Tom Schäfer
Firma Straub KG, 99867 Gotha
No response
The API Docs mention /accounts/connectToSocialAccount & /accounts/disconnectToSocialAccount endpoints at /accounts/{accountId}
Sadly, those endpoints don't seem to be documented. Could you provide guidance on how to use these?
Thanks for your time.
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
Django
The Web framework for perfectionists with deadlines.
Laravel
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft
Open source projects and samples from Microsoft.
Google
Google ❤️ Open Source for everyone.
Alibaba
Alibaba Open Source for everyone
D3
Data-Driven Documents codes.
Tencent
China tencent open source team.