Primetric REST API allows you to access and manipulate data on Primetric platform.
\nAPI is under development and new features will be added over time.
\nApi is avaliable at https://api.primetric.com/{{version}}/
\nAvailable version: https://api.primetric.com/beta/
\nApi use OAuth2.0 authorization. You must add and authorize Application in administrator panel in order to use API.
\nAuthorize endpoint:
https://api.primetric.com/auth/authorize/
Token endpoint:
https://api.primetric.com/auth/token/
Only the \"authorization code\" and \"client credentials\" grant types are available.
\nTo learn about OAuth2 you can read one of
\n\ntutorials on the internet.
\nThe \"authorization code\" method works by granting an access token to clients. It is important to understand that this token does not differentiate between users or their individual permissions. This means that all authenticated clients will have the same level of access to the API resources.
\nimport requests\nfrom requests.auth import HTTPBasicAuth \nurl = \"https://api.primetric.com/auth/token/\"\nclient_id = \"xx\"\nclient_secret = \"yy\"\nscope = [\"read\", \"write\", \"finance\"]\nauth = HTTPBasicAuth(client_id, client_secret)\ndata = {\n \"grant_type\": \"client_credentials\",\n \"scope\": \" \".join(scope)\n }\nresponse = requests.post(url, data=data, auth=auth)\nprint(response.text)\n\nread - read scope
\nwrite - write scope
\nfinance - finance data access
\nEvery endpoint which return list is paginated.
Page size is set to 50 items.
sample paginated response
\n{\n \"count\": 99,\n \"next\": \"https://api.primetric.com/beta/projects/?page=2\"\n \"previous\": null,\n \"results\": [...]\n}\n\ncount - total items count
\nnext - url to the next page or null if not exists
\nprevious - url to the previous page or null if not exists
\nresults - array of returned objects
\nAdvanced filtering is available for certian endpoints. More info in here https://primetric.atlassian.net/wiki/spaces/PCD/pages/14450698/Public+API
\nPlease be aware that all requests should end with a slash \"/\"
\n60 requests/minute
\nException Code 429 if exceeded
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Overview","slug":"overview"},{"content":"Authentication","slug":"authentication"},{"content":"Pagination","slug":"pagination"},{"content":"Advanced filtering","slug":"advanced-filtering"},{"content":"Additional Notes","slug":"additional-notes"},{"content":"Error codes","slug":"error-codes"},{"content":"Rate limits","slug":"rate-limits"}],"owner":"10359207","collectionId":"3f97ae20-a664-4ae6-a1ef-f30bda8c2a8f","publishedId":"TVssinvS","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"141E74"},"publishDate":"2020-12-21T07:42:39.000Z"},"item":[{"name":"Projects","item":[{"name":"RAG Ratings","item":[{"name":"List RAG Ratings","id":"e1737d7f-e66e-4e36-b939-f0aa1328c2db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.primetric.com/beta/projects/{project_id}/rag_ratings/","auth":{"type":"oauth2","oauth2":{"accessTokenUrl":"StartFragment
\nUsed to update the RAG rating for a specific project identified by its unique project_id. The RAG rating provides a quick visual indicator of the overall status or health of a project.
\nParams:
\nEndFragment
\n","auth":{"type":"oauth2","oauth2":{"accessTokenUrl":"Lists projects in organization. You can filter results with optional query params. Results are paginated.
\n","auth":{"type":"oauth2","oauth2":{"accessTokenUrl":"number;\n1 - Active,\n2 - Closed
\n","type":"text/plain"},"key":"status","value":""},{"description":{"content":"string; filter exact or fragment of title; case insensitive
\n","type":"text/plain"},"key":"title","value":""},{"description":{"content":"number;\n0 - Times and Material,\n1 - Fixed Price,\n2 - Non Billable
\n","type":"text/plain"},"key":"pricing_model","value":""}],"variable":[]}},"response":[{"id":"b45dd0c9-8935-41b2-b6f5-6cb4c2f96ffd","name":"List projects","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.primetric.com/beta/projects/","host":["https://api.primetric.com/beta"],"path":["projects",""],"query":[{"key":"title","value":"My project","description":"Get specific project from organization.
\n","auth":{"type":"oauth2","oauth2":{"accessTokenUrl":"start_dateend_datecustomer_id
Client/Customer uuid from defined clients
hash_tag_ids
List of tags uuids defined in organization Hash tags
status
1: active\n 2: closed\n\noptional, default is 1
\ntentative
optional, default is false
Specify if project is a draft or actual project
likelihood (only when tentative=true)
optional, default is 50
Specify probability of startig the project. Range: 1-100
project_group_id
optional
Project group uuid from defined Project groups
billing_model
0: Time & Materials\n 1: Fixed price\n 2: Non-billable\n\nIn case of \"Time & Materials\" hour_rate_source param is available
\nhour_rate_source (only when billing_mode is Time & Materials)
0: not set\n 1: Phase\n 2: Role\n 3: Project\n 4: Employee/Contractor default\n 5: Employee/Contractor project default\n\n default is 0
In case of \"Project\", default_hour_rate param is available
default_hour_rate (billing_mode=\"Times & Materials\" and hour_rate_source=\"Project\")
Specify hour rate
currency
Default is taken from organization settings
color
Project label color in hex format, default: 16a085
description
assigned_manager_ids
List of uuids of assigned managers to this
assigned_manager_readonly_ids
List of uuids of assigned managers to this project with only reading permissions
title
customer_id
Client/Customer uuid from defined clients
hash_tag_ids
List of tags uuids defined in organization Hash tags
status
1: active\n 2: closed\n\noptional, default is 1
\ntentative
optional, default is false
Specify if project is a draft or actual project
likelihood (only when tentative=true)
optional, default is 50
Specify probability of startig the project. Range: 1-100
project_group_id
optional
Project group uuid from defined Project groups
hour_rate_source (only when billing_mode is Time & Materials)
0: not set\n 1: Phase\n 2: Role\n 3: Project\n 4: Employee/Contractor default\n 5: Employee/Contractor project default\n\n default is 0
In case of \"Project\", default_hour_rate param is available
default_hour_rate (billing_mode=\"Times & Materials\" and hour_rate_source=\"Project\")
Specify hour rate
currency
Default is taken from organization settings
color
Project label color in hex format, default: 16a085
description
assigned_manager_ids
List of uuids of assigned managers to this
assigned_manager_readonly_ids
List of uuids of assigned managers to this project with only reading permissions
Use this endpoint if you want to perform bulk operations on a single project. (ie. adding 325 worklogs to projects assignments) The system won't be updating project data after each query. After performing all operations use \"End bulk operation\" to back to normal project state.
\n","auth":{"type":"oauth2","oauth2":{"accessTokenUrl":"End bulk operation. This query may take a while depending on the size of the project.
\n","auth":{"type":"oauth2","oauth2":{"accessTokenUrl":"Remove project from organization.
\n","auth":{"type":"oauth2","oauth2":{"accessTokenUrl":"Endpoint is returning financial data for a project, including estimated vs planned vs actual metrics with phase-level breakdown.
\nPermission required: Financial scope
\nResponse structure:
\nThe endpoint returns a JSON object with to main sections:
\nSingle object with uuid and estimated/planned/actual metrics
\nArray of objects, each with same structure as project level.
\nEach metric group contains:
\nrevenue - in company currency
\ncost - in company currency
\nminutes - total work in minutes
\nmargin - percentage (null in cases when the denominator/revenue is equal to 0)
\nLists projects in organization. You can filter results with optional query params. Results are paginated.
\n","auth":{"type":"oauth2","oauth2":{"accessTokenUrl":"uuid of project
\n","type":"text/plain"},"key":"project_id","value":"{{project_id}}"},{"disabled":true,"description":{"content":"string; Exact name of fragment of name; case insensitive
\n","type":"text/plain"},"key":"label","value":""}],"variable":[]}},"response":[{"id":"b232e1f7-e659-4b6f-be98-d3ec3ea7f757","name":"List Phases","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.primetric.com/beta/projects_phases/","host":["https://api.primetric.com/beta"],"path":["projects_phases",""],"query":[{"key":"project_id","value":"a0cd0ffbe4dd408d8830c583d9fe3a54","disabled":true}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 2,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"uuid\": \"8c434be0144b4202ac3525fd1b1b58fd\",\n \"label\": \"Other\",\n \"start_date\": null,\n \"end_date\": null,\n \"is_default\": true,\n \"custom_attributes\": [\n {\n \"slug\": \"name_of_phases_custom_attribute\",\n \"value\": [\n \"test\"\n ]\n }\n ],\n \"estimated_work\": null,\n \"assignment_template_role_id\": null,\n \"assignment_template_note\": null,\n \"project_id\": \"6b1cfb58b5c241b38ae14d44f74f117e\",\n \"budget_lock\": false,\n \"avg_hour_price\": {\n \"amount\": 0,\n \"currency\": \"PLN\",\n \"exchange_rate\": 1\n },\n \"avg_hour_cost\": {\n \"amount\": 0,\n \"currency\": \"PLN\",\n \"exchange_rate\": 1\n },\n \"cost\": {\n \"amount\": 0,\n \"currency\": \"PLN\",\n \"exchange_rate\": 1\n },\n \"income\": {\n \"amount\": 0,\n \"currency\": \"PLN\",\n \"exchange_rate\": 1\n }\n },\n {\n \"uuid\": \"00e045cc6c2647619ed408696141da17\",\n \"label\": \"Phase_1\",\n \"start_date\": \"2018-01-01\",\n \"end_date\": \"2021-12-31\",\n \"is_default\": false,\n \"custom_attributes\": [\n {\n \"slug\": \"name_of_phases_custom_attribute\",\n \"value\": [\n \"test\"\n ]\n }\n ],\n \"estimated_work\": null,\n \"assignment_template_role_id\": \"2da6415a48904e13b827a516e6b2499e\",\n \"assignment_template_note\": \"Instructions\",\n \"project_id\": \"6d0ab59e1348426d8d85746d452438cb\",\n \"budget_lock\": false,\n \"avg_hour_price\": {\n \"amount\": 30,\n \"currency\": \"PLN\",\n \"exchange_rate\": 1\n },\n \"avg_hour_cost\": {\n \"amount\": 20,\n \"currency\": \"PLN\",\n \"exchange_rate\": 1\n },\n \"cost\": {\n \"amount\": 3200,\n \"currency\": \"PLN\",\n \"exchange_rate\": 1\n },\n \"income\": {\n \"amount\": 4800,\n \"currency\": \"PLN\",\n \"exchange_rate\": 1\n }\n }\n ]\n}"}],"_postman_id":"76dc15c5-00c2-494a-9bd5-8461e7644418"},{"name":"Get Phase","id":"f39bee20-08ac-41d3-b5ea-a2d93475ec25","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.primetric.com/beta/projects_phases/{projects_phase_uuid}/","description":"Lists projects in organization. You can filter results with optional query params. Results are paginated.
\n","auth":{"type":"oauth2","oauth2":{"accessTokenUrl":"Financial data representing money are displayed as json objects which will be used below as *money object* with a structure\n{\n \"amount\": amount of money ,\n \"currency\": currency in iso-alpha3 format,\n \"exchange_rate\": decimal representing rate of client currency and company currency\n}\nSometimes currency in project is different than company currency, using these kind of structure is easier to read.\n\nFinancial data representing money are displayed as json objects which will be used below as *money object* with a structure\n{\n \"amount\": amount of money ,\n \"currency\": currency in iso-alpha3 format,\n \"exchange_rate\": decimal representing rate of client currency and company currency\n}\nSometimes currency in project is different than company currency, using these kind of structure is easier to read.\n\nLists projects in organization. You can filter results with optional query params. Results are paginated.
\n","auth":{"type":"oauth2","oauth2":{"accessTokenUrl":"uuid of project
\n","type":"text/plain"},"key":"project_id","value":""},{"disabled":true,"description":{"content":"represents title field, exact or fragment of title, case insensitive
\n","type":"text/plain"},"key":"label","value":""}],"variable":[]}},"response":[{"id":"2f527538-8cd8-4ff9-888c-cce8818a525f","name":"List Scheduled Overheads","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.primetric.com/beta/projects_overheads/scheduled/","host":["https://api.primetric.com/beta"],"path":["projects_overheads","scheduled",""],"query":[{"key":"project_id","value":"","disabled":true}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 2,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"uuid\": \"2da6415a48904e13b827a516e6b2499e\",\n \"created_at\": \"2022-05-10T09:46:58.427569Z\",\n \"updated_at\": \"2022-05-10T12:03:01.467487+02:00\",\n \"date\": \"2022-05-10\",\n \"project_id\": \"6d0ab59e1348426d8d85746d452438cb\",\n \"label\": \"Income\",\n \"note\": \"Description of the income\",\n \"money\": {\n \"amount\": 2000,\n \"currency\": \"PLN\",\n \"exchange_rate\": 1\n },\n \"category\": \"income\",\n \"enable_autocommit\": true,\n \"realized_in_id\": \"165100162d6f4423bd49e0382859fe88\",\n \"autocommit_state\": \"settled\"\n },\n {\n \"uuid\": \"23bdd9a0c6cd446886ede7253bcaf165\",\n \"created_at\": \"2022-05-10T09:47:10.226040Z\",\n \"updated_at\": \"2022-05-10T11:50:29.993463+02:00\",\n \"date\": \"2022-05-10\",\n \"project_id\": \"2557a7e59c9146f585e43f4a930e9cd1\",\n \"label\": \"Cost\",\n \"note\": \"Description of the cost\",\n \"money\": {\n \"amount\": 1000,\n \"currency\": \"PLN\",\n \"exchange_rate\": 1\n },\n \"category\": \"cost\",\n \"enable_autocommit\": false,\n \"realized_in_id\": null,\n \"autocommit_state\": \"settled\"\n }\n ]\n}"}],"_postman_id":"53ae7548-fecf-48be-a047-3c22e3fe3d98"},{"name":"Get Scheduled Overhead","id":"532deaed-418d-40a9-9a9a-b62dea358b81","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.primetric.com/beta/projects_overheads/scheduled/{overhead_uuid}/","description":"Lists projects in organization. You can filter results with optional query params. Results are paginated.
\n","auth":{"type":"oauth2","oauth2":{"accessTokenUrl":"Parameters
\n","auth":{"type":"oauth2","oauth2":{"accessTokenUrl":"/commit/Scheduled overheads are the one included in the project’s tab in Budget > Scheduled.
\nScheduled overheads can be an income or a cost.
\nScheduled overheads can be automatically committed - at the date of commit new overhead is created which can have status as settled or not settled, depending on autocommit_state. When overhead is scheduled for a past date and autocommit is enabled, new overhead (committed) is created which uuid is available in realized_in_id field.
To use overheads in public api finance scope need to be enabled. It is impossible to use this endpoint without financial scope.
\n","_postman_id":"b89f19a4-5905-42d0-9bdf-6845e0cf8599","auth":{"type":"oauth2","oauth2":{"accessTokenUrl":"uuid of project
\n","type":"text/plain"},"key":"project_id","value":""},{"disabled":true,"description":{"content":"represents title field, exact or fragment of title, case insensitive
\n","type":"text/plain"},"key":"label","value":""}],"variable":[]}},"response":[{"id":"f90c7422-cf4f-4076-a08a-5f6e2e6cd158","name":"List Committed Overheads","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.primetric.com/beta/projects_overheads/committed/","host":["https://api.primetric.com/beta"],"path":["projects_overheads","committed",""],"query":[{"key":"project_id","value":"","disabled":true}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 3,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"uuid\": \"8c434be0144b4202ac3525fd1b1b58fd\",\n \"created_at\": \"2022-05-10T09:57:02.067766Z\",\n \"updated_at\": \"2022-05-10T11:57:02.068239+02:00\",\n \"date\": \"2022-05-10\",\n \"project_id\": \"6b1cfb58b5c241b38ae14d44f74f117e\",\n \"label\": \"Not settled income\",\n \"note\": \"Description of not settled income\",\n \"money\": {\n \"amount\": 2000,\n \"currency\": \"PLN\",\n \"exchange_rate\": 1\n },\n \"category\": \"income\",\n \"planed_in_id\": null,\n \"settled\": false\n },\n {\n \"uuid\": \"00e045cc6c2647619ed408696141da17\",\n \"created_at\": \"2022-05-10T09:58:36.130075Z\",\n \"updated_at\": \"2022-05-10T11:58:36.130587+02:00\",\n \"date\": \"2022-05-10\",\n \"project_id\": \"1d50e9cc890d455c90c54edd18f699f2\",\n \"label\": \"Not_settled cost\",\n \"note\": \"This is a note\",\n \"money\": {\n \"amount\": 1000,\n \"currency\": \"PLN\",\n \"exchange_rate\": 1\n },\n \"category\": \"cost\",\n \"planed_in_id\": null,\n \"settled\": false\n },\n {\n \"uuid\": \"2da6415a48904e13b827a516e6b2499e\",\n \"created_at\": \"2022-05-10T12:44:50.673099Z\",\n \"updated_at\": \"2022-05-10T14:44:50.673458+02:00\",\n \"date\": \"2022-05-10\",\n \"project_id\": \"6d0ab59e1348426d8d85746d452438cb\",\n \"label\": \"Koszt\",\n \"note\": \"Description of cost\",\n \"money\": {\n \"amount\": 1000,\n \"currency\": \"PLN\",\n \"exchange_rate\": 1\n },\n \"category\": \"cost\",\n \"planed_in_id\": \"165100162d6f4423bd49e0382859fe88\",\n \"settled\": true\n }\n ]\n}"}],"_postman_id":"9c0ed285-4389-4a96-99c6-88f3260e6bc0"},{"name":"Get Committed Overhead","id":"58fa29e1-0f10-4359-b6fc-98815378f5b1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.primetric.com/beta/projects_overheads/committed/{overhead_uuid}/","auth":{"type":"oauth2","oauth2":{"accessTokenUrl":"