.png?height=120&name=logo_blue%20(1).png){kind=logo}
How to get one or all the projects belonging to the authenticated user that are in the root workspace (not part of any folder).
-
Fetch all your projects
Sandbox endpoint
https://api.platform.easytranslate.com/laas/api/v1/teams/:team_identifier/projects
In order to fetch all your projects, you need to send a GET request.
In your request's header, you need to add your access token, to do so, simply add "Authorization" as a key and "Bearer {{ACCESS_TOKEN}}" (instead of {{ACCESS_TOKEN}}, you should provide your access token)
You also need to pass a variable (team_identifier) in the path of your endpoint
-
- Team_identifier : {{TEAM_IDENTIFIER}}
Instead of {{TEAM_IDENTIFIER}} in the request example below, you need to provide the team_identifier of your team. It can be retrieved from the api/v1/user endpoint. The team_identifier is used to identify the projects of the authenticated account.
- Team_identifier : {{TEAM_IDENTIFIER}}
Sandbox request example
curl --location -g --request GET 'https://api.platform.sandbox.easytranslate.com/api/v1/teams/{{TEAM_NAME}}/projects' \ --header 'Authorization: Bearer {{ACCESS_TOKEN}}'
You have the possibility to filter your results, here are the query filter possibilities:
| status[] | Array of status strings |
Possible values: COMPLETED CREATED APPROVAL_NEEDED PRICE_ACCEPTED PRICE_DECLINED |
| perPage | Number greater than 0 | How much results per page should be visible. |
| page | Number greater than 0 | Switch between the results pages. |
Sandbox response example
Once you get a response from the server, this is the information you will get out of it.
{
"data": [
{
"type": "project",
"id": "fef4877f-6800-4dee-a807-b1600c6e9afa",
"attributes": {
"name": "Application Form #5",
"customer_id": "56e9b95b-7892-4eda-b28e-0b8a7e52b4f3",
"source_language": "en",
"source_content": "https://api.platform.sandbox.easytranslate.com/api/v1/teams/deadpool/projects/fef4877f-6800-4dee-a807-b1600c6e9afa/download",
"file_name": "(Project)Application Form #5 en to da,de.json",
"target_languages": [
"da",
"de"
],
"agent": "EasyTranslate Dashboard",
"price": {
"amount": 236,
"amount_euro": 200,
"total": 236,
"total_euro": 200,
"currency": "USD"
},
"payment": {
"date": null,
"method": null,
"amount": 236,
"currency": "USD",
"vat_percent": 0.25,
"gross_amount": 296,
"invoice_url": null
},
"status": "PRICE_ACCEPTED",
"folder_id": null,
"folder_name": null,
"callback_url": null,
"progress": {
"percent": 0,
"completed_tasks": 0
},
"created_at": "2020-08-27T08:57:48.000000Z",
"updated_at": "2020-08-27T08:57:56.000000Z"
},
"relationships": []
},
{
"type": "project",
"id": "0be274da-a941-4fec-9c0e-b24f91ab2250",
"attributes": {
"name": "Application Form #4",
"customer_id": "56e9b95b-7892-4eda-b28e-0b8a7e52b4f3",
"source_language": "en",
"source_content": "https://api.platform.sandbox.easytranslate.com/api/v1/teams/deadpool/projects/0be274da-a941-4fec-9c0e-b24f91ab2250/download",
"file_name": "(Project)Application Form #4 en to da,de.json",
"target_languages": [
"da",
"de"
],
"agent": "EasyTranslate Dashboard",
"price": {
"amount": 236,
"amount_euro": 200,
"total": 236,
"total_euro": 200,
"currency": "USD"
},
"payment": {
"date": null,
"method": null,
"amount": 236,
"currency": "USD",
"vat_percent": 0.25,
"gross_amount": 296,
"invoice_url": null
},
"status": "PRICE_ACCEPTED",
"folder_id": null,
"folder_name": null,
"callback_url": null,
"progress": {
"percent": 0,
"completed_tasks": 0
},
"created_at": "2020-08-27T08:57:45.000000Z",
"updated_at": "2020-08-27T08:57:53.000000Z"
},
"relationships": []
},
{
"type": "project",
"id": "438037d9-cad3-48cc-b253-a33ecf68e2df",
"attributes": {
"name": "Application Form #3",
"customer_id": "56e9b95b-7892-4eda-b28e-0b8a7e52b4f3",
"source_language": "en",
"source_content": "https://api.platform.sandbox.easytranslate.com/api/v1/teams/deadpool/projects/438037d9-cad3-48cc-b253-a33ecf68e2df/download",
"file_name": "(Project)Application Form #3 en to da,de.json",
"target_languages": [
"da",
"de"
],
"agent": "EasyTranslate Dashboard",
"price": {
"amount": 236,
"amount_euro": 200,
"total": 236,
"total_euro": 200,
"currency": "USD"
},
"payment": {
"date": null,
"method": null,
"amount": 236,
"currency": "USD",
"vat_percent": 0.25,
"gross_amount": 296,
"invoice_url": null
},
"status": "PRICE_ACCEPTED",
"folder_id": null,
"folder_name": null,
"callback_url": null,
"progress": {
"percent": 0,
"completed_tasks": 0
},
"created_at": "2020-08-27T08:57:41.000000Z",
"updated_at": "2020-08-27T08:57:50.000000Z"
},
"relationships": []
},
{
"type": "project",
"id": "79a8f137-4731-4d61-9335-2d649561864d",
"attributes": {
"name": "Application Form #2",
"customer_id": "56e9b95b-7892-4eda-b28e-0b8a7e52b4f3",
"source_language": "en",
"source_content": "https://api.platform.sandbox.easytranslate.com/api/v1/teams/deadpool/projects/79a8f137-4731-4d61-9335-2d649561864d/download",
"file_name": "(Project)Application Form #2 en to da,de.json",
"target_languages": [
"da",
"de"
],
"agent": "EasyTranslate Dashboard",
"price": {
"amount": 236,
"amount_euro": 200,
"total": 236,
"total_euro": 200,
"currency": "USD"
},
"payment": {
"date": null,
"method": null,
"amount": 236,
"currency": "USD",
"vat_percent": 0.25,
"gross_amount": 296,
"invoice_url": null
},
"status": "PRICE_ACCEPTED",
"folder_id": null,
"folder_name": null,
"callback_url": null,
"progress": {
"percent": 0,
"completed_tasks": 0
},
"created_at": "2020-08-27T08:51:45.000000Z",
"updated_at": "2020-08-27T08:51:54.000000Z"
},
"relationships": []
}
],
"links": {
"first": "https://api.platform.sandbox.easytranslate.com/api/v1/teams/deadpool/projects?page=1",
"last": "https://api.platform.sandbox.easytranslate.com/api/v1/teams/deadpool/projects?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"path": "https://api.platform.sandbox.easytranslate.com/api/v1/teams/deadpool/projects",
"per_page": 15,
"to": 4,
"total": 4,
"copyright": "Copyright 2020 EasyTranslate A/S",
"environment": "sandbox"
}
}
-
Fetch a project
Sandbox endpoint
https://api.platform.sandbox.easytranslate.com/api/v1/teams/:team_identifier/projects/:project_id
In order to fetch a specific project, you need to send a GET request.
In your request's header, you need to add your access token, to do so, simply add "Authorization" as a key and "Bearer {{ACCESS_TOKEN}}" (instead of {{ACCESS_TOKEN}}, you should provide your access token). In addition to that, you have to add the key "Content-Type" and "application/x-www-form-urlencoded" as its value to your header.
Finally, you need to pass two variables (team_identifier, project_id) in the path of your endpoint
-
- Team_identifier: {{TEAM_IDENTIFIER}}
Instead of {{TEAM_IDENTIFIER}} in the request example below, you need to provide the team_identifier of your team. It can be retrieved from the api/v1/user endpoint. The team_identifier is used to identify the projects of the authenticated account. - Project_id: {{PROJECT_ID}}
Instead of {{PROJECT_ID}} in the request example below, you simply have to specify the ID of the project you want to get.
- Team_identifier: {{TEAM_IDENTIFIER}}
Request example
curl --location -g --request GET 'https://api.platform.sandbox.easytranslate.com/api/v1/teams/{{TEAM_NAME}/projects/{{PROJECT_ID}}' \ --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \ --header 'Content-Type: application/x-www-form-urlencoded'
You have the possibility to filter your results, here are the query filter possibilities:
| status[] | Array of status strings |
Possible values: COMPLETED CREATED APPROVAL_NEEDED PRICE_ACCEPTED PRICE_DECLINED |
| perPage | Number greater than 0 | How much results per page should be visible. |
| page | Number greater than 0 | Switch between the results pages. |
Response example
Once you send your request and get a response from the server, this is the information you will get out of it
{
"data": {
"type": "project",
"id": "ef1e29b6-6dcf-424b-858f-aa7f75a3cf65",
"attributes": {
"name": "Application Form #1",
"customer_id": "56e9b95b-7892-4eda-b28e-0b8a7e52b4f3",
"source_language": "en",
"source_content": "https://api.platform.sandbox.easytranslate.com/api/v1/teams/deadpool/projects/ef1e29b6-6dcf-424b-858f-aa7f75a3cf65/download",
"file_name": "data.json",
"target_languages": [
"da",
"de"
],
"agent": "EasyTranslate Dashboard",
"price": {
"amount": 14526,
"amount_euro": 12272,
"total": 14526,
"total_euro": 12272,
"currency": "USD"
},
"payment": {
"date": "2020-08-27",
"method": "digital",
"amount": 14526,
"currency": "USD",
"vat_percent": 0.25,
"gross_amount": 18158,
"invoice_url": "https://pay.stripe.com/invoice/acct_19n4RfHbEySjdvVG/invst_HuVfvi1eU4LZeX1rQCLXwXJ5mBp2DXQ/pdf"
},
"status": "ASSIGNED",
"folder_id": "27cf582a-9b22-41bf-a0ce-c9efefb66622",
"folder_name": "X-FORCE",
"callback_url": null,
"progress": {
"percent": 0.5,
"completed_tasks": 1
},
"created_at": "2020-08-27T08:39:27.000000Z",
"updated_at": "2020-08-27T08:39:58.000000Z"
},
"relationships": {
"tasks": [
{
"id": "d4739c6c-fc0f-413f-b69d-caa288b30487",
"type": "task"
},
{
"id": "df0f12b5-1db6-4822-a76b-882c0109283a",
"type": "task"
}
]
}
},
"included": [
{
"type": "task",
"id": "d4739c6c-fc0f-413f-b69d-caa288b30487",
"attributes": {
"target_content": null,
"target_language": "da",
"type": "translation",
"file_name": "data.json",
"word_count": 472,
"deadline": null,
"status": "COMPLETED",
"price": {
"amount": 7263,
"amount_euro": 6136,
"total": 7263,
"total_euro": 6136,
"currency": "USD"
},
"payment": {
"date": "2020-08-27",
"method": "digital",
"amount": 7263,
"currency": "USD",
"vat_percent": 0.25,
"gross_amount": 9079,
"invoice_url": "https://pay.stripe.com/invoice/acct_19n4RfHbEySjdvVG/invst_HuVfvi1eU4LZeX1rQCLXwXJ5mBp2DXQ/pdf"
},
"supplier_id": "70330f42-9c2c-4aaa-882d-fe46a17f960a",
"project_id": "ef1e29b6-6dcf-424b-858f-aa7f75a3cf65",
"progress": "0",
"is_rated": false,
"created_at": "2020-08-27T08:39:28.000000Z",
"updated_at": "2020-08-27T08:41:31.000000Z"
},
"relationships": []
},
{
"type": "task",
"id": "df0f12b5-1db6-4822-a76b-882c0109283a",
"attributes": {
"target_content": null,
"target_language": "de",
"type": "translation",
"file_name": "data.json",
"word_count": 472,
"deadline": null,
"status": "ASSIGNED",
"price": {
"amount": 7263,
"amount_euro": 6136,
"total": 7263,
"total_euro": 6136,
"currency": "USD"
},
"payment": {
"date": "2020-08-27",
"method": "digital",
"amount": 7263,
"currency": "USD",
"vat_percent": 0.25,
"gross_amount": 9079,
"invoice_url": "https://pay.stripe.com/invoice/acct_19n4RfHbEySjdvVG/invst_HuVfvi1eU4LZeX1rQCLXwXJ5mBp2DXQ/pdf"
},
"supplier_id": "d2868128-ee54-4514-9c53-26a312649622",
"project_id": "ef1e29b6-6dcf-424b-858f-aa7f75a3cf65",
"progress": "0",
"is_rated": false,
"created_at": "2020-08-27T08:39:28.000000Z",
"updated_at": "2020-08-27T08:39:57.000000Z"
},
"relationships": []
}
],
"meta": {
"copyright": "Copyright 2020 EasyTranslate A/S",
"environment": "sandbox"
}
}