XTRF Home Portal API
XTRF Home Portal API enables you to perform operations on Projects, Quotes, Customers, Vendors etc. as a XTRF Home Portal user. The documentation is generated…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
XTRF Home Portal API enables you to perform operations on Projects, Quotes, Customers, Vendors etc. as a XTRF Home Portal user. The documentation is generated from OpenAPI specification 3.0 available here
The API client/consumer code may be easily generated in 60+ programming languages using an open source code generator available at the time of writing this documentation at https://editor.swagger.io/ Thank you for using XTRF Application Programming interface (XTRF API). By using the API you agree to the terms below. If you disagree with any of these terms, XTRF does not grant you a license to use the XTRF API. XTRF reserves the right to update and change these terms from time to time without a prior notice of API users. You can always find the most recent version of these terms here:
Endpoints 284
Browser
- GETSearches for data (ie. customer, task, etc) and returns it in a tabular form.
/browser?viewId=0&page=0&additionalOrder=string&useDeferredColumns=string&maxRows=0Searches for data (ie. customer, task, etc) and returns it in a tabular form. - GETSearches for data (ie. customer, task, etc) and returns it in a CSV form.
/browser/csv?viewId=0&separator=string&secondarySeparator=string&additionalOrder=stringSearches for data (ie. customer, task, etc) and returns it in a CSV form. - GETReturns current view's detailed information, suitable for browser.
/browser/views/details/for/:className?placeName=defaultReturns current view's detailed information, suitable for browser. - GETReturns view's detailed information, suitable for browser.
/browser/views/details/for/:className/:viewId?placeName=defaultReturns view's detailed information, suitable for browser. - POSTSelects given view as current and returns its detailed information, suitable for browser.
/browser/views/details/for/:className/:viewId?place name (denotes specific place in system with the table)=defaultSelects given view as current and returns its detailed information, suitable for browser. - GETReturns views' brief.
/browser/views/for/:className?placeName=defaultReturns views' brief. - POSTCreates view for given class.
/browser/views/for/:classNameCreates view for given class. - GETReturns all view's information.
/browser/views/:viewIdReturns all view's information (ie. name, columns, filters, etc). - PUTUpdates all view's information.
/browser/views/:viewIdUpdates all view's information (ie. name, columns, filters, etc). - DELETERemoves a view.
/browser/views/:viewIdRemoves a view. No content is returned upon success (204). - GETReturns columns defined in view.
/browser/views/:viewId/columnsReturns columns defined in view. - PUTUpdates columns in view.
/browser/views/:viewId/columnsUpdates columns in view. - DELETEDeletes a single column from view.
/browser/views/:viewId/columns/:columnNameDeletes a single column from view. - GETReturns column's specific settings.
/browser/views/:viewId/columns/:columnName/settingsReturns column's specific settings. For example when column describes money amount we can decide whether it should display currency or not. - PUTUpdates column's specific settings.
/browser/views/:viewId/columns/:columnName/settingsUpdates column's specific settings. For example when column describes money amount we can decide whether it should display currency or not. - GETReturns view's filter.
/browser/views/:viewId/filterReturns view's filter. - PUTUpdates view's filter.
/browser/views/:viewId/filterUpdates view's filter. - PUTUpdates view's filter property.
/browser/views/:viewId/filter/:filterPropertyUpdates view's filter property. - GETReturns view's order settings.
/browser/views/:viewId/orderReturns view's order settings. - PUTUpdates view's order settings.
/browser/views/:viewId/orderUpdates view's order settings. - GETReturns view's permissions.
/browser/views/:viewId/permissionsReturns view's permissions. - PUTUpdates view's permissions.
/browser/views/:viewId/permissionsUpdates view's permissions. - GETReturns view's settings.
/browser/views/:viewId/settingsReturns view's settings (ie. name). - PUTUpdates view's settings.
/browser/views/:viewId/settingsUpdates view's settings. - GETReturns view's local settings (for current user).
/browser/views/:viewId/settings/localReturns view's local settings (for current user). - PUTUpdates view's local settings (for current user).
/browser/views/:viewId/settings/localUpdates view's local settings (for current user).
Client Invoices
- GETLists all client invoices in all statuses (including not ready and drafts) that have been updated since a specific date.
/accounting/customers/invoices?updatedSince=0Lists all client invoices in all statuses (including not ready and drafts) that have been updated since a specific date. - POSTCreates a new invoice.
/accounting/customers/invoicesCreates a new invoice from tasks. Tasks are grouped by client and currency, therefore multiple invoices can be created.If any of the tasks cannot be invoiced… - POSTGenerates client invoices' documents.
/accounting/customers/invoices/documentsGenerates client invoices' documents. - GETReturns client invoices' internal identifiers.
/accounting/customers/invoices/ids?updatedSince=0Returns client invoices' internal identifiers. - POSTSends reminders. Returns number of sent e-mails.
/accounting/customers/invoices/sendRemindersSends reminders. Returns number of sent e-mails. - GETReturns client invoice details.
/accounting/customers/invoices/:invoiceId?embed=stringReturns client invoice details. - DELETERemoves a client invoice.
/accounting/customers/invoices/:invoiceIdRemoves a client invoice. - GETReturns dates of a given client invoice.
/accounting/customers/invoices/:invoiceId/datesReturns dates of a given client invoice. - GETGenerates client invoice document (PDF).
/accounting/customers/invoices/:invoiceId/documentGenerates client invoice document (PDF). - POSTDuplicate client invoice.
/accounting/customers/invoices/:invoiceId/duplicateDuplicate client invoice. - POSTDuplicate client invoice as pro forma.
/accounting/customers/invoices/:invoiceId/duplicate/proFormaDuplicate client invoice as pro forma. - GETReturns payment terms of a given client invoice.
/accounting/customers/invoices/:invoiceId/paymentTermsReturns payment terms of a given client invoice. - GETReturns all payments for the client invoice.
/accounting/customers/invoices/:invoiceId/paymentsReturns all payments for the client invoice. - POSTAdds a new payment to the client invoice. The invoice payment status (Not Paid, Partially Paid, Fully Paid) is automatically recalculated.
/accounting/customers/invoices/:invoiceId/paymentsAdds a new payment to the client invoice. The invoice payment status (Not Paid, Partially Paid, Fully Paid) is automatically recalculated. - POSTSends reminder.
/accounting/customers/invoices/:invoiceId/sendReminderSends reminder. - DELETERemoves a customer payment.
/accounting/customers/payments/:paymentIdRemoves a customer payment.
Clients
- GETReturns list of simple clients representations
/customers?updatedSince=0Returns list of simple clients representations - POSTCreates a new client.
/customersCreates a new client. All available fields are presented in PUT request.<p> Required fields: <ul> <li>name</li> <li>fullName</li> <li>contact -> emails ->… - GETReturns clients' internal identifiers.
/customers/ids?updatedSince=0&nameEquals=string&emailEquals=stringReturns clients' internal identifiers. - POSTCreates a new person.
/customers/personsCreates a new person. Required fields are presented in the example. Other fields (from PUT) may also be specified here. - POSTGenerates a single use sign-in token.
/customers/persons/accessTokenGenerates a single use sign-in token for the customer person found for given login or e-mail. Returns 'url' and 'token' which allows to sign-in to customer… - GETReturns persons' internal identifiers.
/customers/persons/ids?updatedSince=0Returns persons' internal identifiers. - GETReturns person details.
/customers/persons/:personIdReturns person details. - PUTUpdates an existing person.
/customers/persons/:personIdOnly specified fields will be changed. One may not specify embeddable fields here - use separate API calls for updating them. - DELETERemoves a person.
/customers/persons/:personIdRemoves a person. - GETReturns contact of a given person.
/customers/persons/:personId/contactReturns contact of a given person. - PUTUpdates contact of a given person.
/customers/persons/:personId/contactUpdates contact of a given person. Sets that this person uses specific address and contact (not the one from customer). - GETReturns custom fields of a given person.
/customers/persons/:personId/customFieldsReturns custom fields of a given person. - PUTUpdates custom fields of a given person.
/customers/persons/:personId/customFieldsUpdates custom fields of a given person. - DELETERemoves a customer price list.
/customers/priceLists/:priceListIdRemoves a customer price list. - GETReturns client details.
/customers/:customerId?embed=stringReturns client details. - PUTUpdates an existing client.
/customers/:customerIdOnly specified fields will be changed (id is required). One may not specify embeddable fields here - use separate API calls for updating them. - DELETERemoves a client.
/customers/:customerIdRemoves a client. - GETReturns address of a given client.
/customers/:customerId/addressReturns address of a given client. - PUTUpdates address of a given client.
/customers/:customerId/addressUpdates address of a given client. - GETReturns categories of a given client.
/customers/:customerId/categoriesReturns categories of a given client. - PUTUpdates categories of a given client.
/customers/:customerId/categoriesUpdates categories of a given client. - GETReturns contact of a given client.
/customers/:customerId/contactReturns contact of a given client. - PUTUpdates contact of a given client.
/customers/:customerId/contactUpdates contact of a given client. - GETReturns correspondence address of a given client.
/customers/:customerId/correspondenceAddressReturns correspondence address of a given client. - PUTUpdates correspondence address of a given client.
/customers/:customerId/correspondenceAddressUpdates correspondence address of a given client. - GETReturns custom fields of a given client.
/customers/:customerId/customFieldsReturns custom fields of a given client. - PUTUpdates custom fields of a given client.
/customers/:customerId/customFieldsUpdates custom fields of a given client. - GETReturns custom field of a given client.
/customers/:customerId/customFields/:customFieldKeyReturns custom field of a given client. - PUTUpdates given custom field of a given client.
/customers/:customerId/customFields/:customFieldKeyUpdates given custom field of a given client. - GETReturns industries of a given client.
/customers/:customerId/industriesReturns industries of a given client. - PUTUpdates industries of a given client.
/customers/:customerId/industriesUpdates industries of a given client.
Dictionaries
- GETReturns active dictionary entities for all types.
/dictionaries/activeReturns active dictionary entities for all types. - GETReturns dictionary entities for all types. Both active and not active ones.
/dictionaries/all<div> <p> XTRF holds many user-defined dictionaries (ie. countries). Each dictionary contains a set of values (ie. Poland or Germany). A default value may be… - GETReturns active values from a given dictionary.
/dictionaries/:type/active?nameEquals=stringReturns active values from a given dictionary. - GETReturns all values (both active and not active) from a given dictionary.
/dictionaries/:type/all?nameEquals=stringReturns all values (both active and not active) from a given dictionary. - GETReturns specific value from a given dictionary.
/dictionaries/:type/:idReturns specific value from a given dictionary. - GETReturns active services list
/services/active?nameEquals=stringReturns active workflows list - GETReturns services list
/services/all?nameEquals=stringReturns workflows list. Both active and not active ones.
Currency exchange rates
- GETReturns currency exchange rates.
/dictionaries/currency/:isoCode/exchangeRateReturns currency exchange rates. - POSTAdding currency exchange rates.
/dictionaries/currency/:isoCode/exchangeRateAdding currency exchange rates via API
Files
- POSTUploads a temporary file (ie. for XML import). Returns token which can be used in other API calls.
/filesWhen a file is required by an operation (ie. task creation) it must be uploaded previously to the API. Uploading a file will result in a file token, which can…
License
- GETReturns license content.
/licenseReturns license content. - POSTRefreshes license content.
/license/refreshRefreshes license content. This method returns OK immediately and license is refreshed asynchronously. It takes a while (usually a few seconds) for the…
Macros
- POSTExecutes a macro.
/macros/:macroId/runRuns a specified macro on a specified list of items ("list" variable in the macro code). The list of items can be empty if the macro doesn't use it.…
Vendor Invoices
- GETLists all vendor invoices in all statuses (including not ready and drafts) that have been updated since a specific date.
/accounting/providers/invoices?updatedSince=0Lists all vendor invoices in all statuses (including not ready and drafts) that have been updated since a specific date. - POSTCreates a new invoice.
/accounting/providers/invoicesCreates a new invoice from jobs. Jobs are grouped by provider and currency, therefore multiple invoices can be created.If any of the jobs cannot be invoiced… - GETReturns vendor invoices' internal identifiers.
/accounting/providers/invoices/ids?updatedSince=0Returns vendor invoices' internal identifiers. - GETReturns provider invoice details.
/accounting/providers/invoices/:invoiceIdReturns provider invoice details. - DELETERemoves a provider invoice.
/accounting/providers/invoices/:invoiceIdRemoves a provider invoice. - GETGenerates provider invoice document (PDF).
/accounting/providers/invoices/:invoiceId/documentGenerates provider invoice document (PDF). - GETReturns all payments for the vendor invoice.
/accounting/providers/invoices/:invoiceId/paymentsReturns all payments for the vendor invoice. - POSTCreates a new payment on the vendor account and assigns the payment to the invoice.
/accounting/providers/invoices/:invoiceId/paymentsCreates a new payment on the vendor account and assigns the payment to the invoice. - POSTSends a provider invoice.
/accounting/providers/invoices/:invoiceId/sendSends a provider invoice. - POSTChanges invoice status to given status.
/accounting/providers/invoices/:invoiceId/statusChanges invoice status to given status. - DELETERemoves a provider payment.
/accounting/providers/payments/:paymentIdRemoves a provider payment.
Vendors
- GETReturns providers' internal identifiers.
/providers/ids?updatedSince=0Returns providers' internal identifiers. - GETReturns persons' internal identifiers.
/providers/persons/ids?updatedSince=0Returns persons' internal identifiers. - GETReturns person details.
/providers/persons/:personIdReturns person details. - DELETERemoves a person.
/providers/persons/:personIdRemoves a person. - GETReturns contact of a given person.
/providers/persons/:personId/contactReturns contact of a given person. - GETReturns custom fields of a given person.
/providers/persons/:personId/customFieldsReturns custom fields of a given person. - POSTSends invitation to Vendor Portal.
/providers/persons/:personId/notification/invitationSends invitation to Vendor Portal. - DELETERemoves a provider price list.
/providers/priceLists/:priceListIdRemoves a provider price list. - GETReturns provider details.
/providers/:providerId?embed=stringReturns provider details. - DELETERemoves a provider.
/providers/:providerIdRemoves a provider. - GETReturns address of a given provider.
/providers/:providerId/addressReturns address of a given provider. - GETReturns competencies of a given provider.
/providers/:providerId/competenciesReturns competencies of a given provider. - GETReturns contact of a given provider.
/providers/:providerId/contactReturns contact of a given provider. - GETReturns correspondence address of a given provider.
/providers/:providerId/correspondenceAddressReturns correspondence address of a given provider. - GETReturns custom fields of a given provider.
/providers/:providerId/customFieldsReturns custom fields of a given provider. - POSTSends invitations to Vendor Portal.
/providers/:providerId/notification/invitationSends invitations to Vendor Portal.
Reports
- POSTExports reports definition to XML.
/reports/export/xmlExports reports definition to XML. - POSTImports reports definition from XML.
/reports/import/xmlImports a report definition from an XML using a file token. To obtain the token, you first need to upload a temporary XML file, as specified in the Files… - DELETERemoves a report.
/reports/:reportIdRemoves a report. - POSTDuplicates a report.
/reports/:reportId/duplicateDuplicates a report. - PUTMarks report as preferred or not.
/reports/:reportId/preferredMarks report as preferred or not. - GETGenerates CSV content for a report.
/reports/:reportId/result/csvGenerates CSV content for a report. - GETGenerates printer friendly content for a report.
/reports/:reportId/result/printerFriendlyGenerates printer friendly content for a report.
Subscription
- GETReturns all subscriptions
/subscriptionReturns all subscriptions. Subscriptions are automatically removed if they do not work (ie. if 404 status is returned). To improve notification reliability… - POSTSubscribe to event
/subscriptionSubscribe to event. Returns subscription Id. - GETThis method can be used to determine if hooks are supported.
/subscription/supportsThis method can be used to determine if hooks are supported. - DELETEUnsubscribe from event
/subscription/:subscriptionIdUnsubscribe from job status changed event
Users
- GETReturns list of simple users representations
/usersReturns list of simple users representations - GETReturns currently signed in user details.
/users/meReturns currently signed in user details. - GETReturns time zone preferred by user currently signed in.
/users/me/timeZoneReturns time zone preferred by user currently signed in. - GETReturns user details.
/users/:userIdReturns user details. - PUTUpdates an existing user.
/users/:userIdUpdates an existing user. - GETReturns custom fields of a given user.
/users/:userId/customFieldsReturns custom fields of a given user. - PUTUpdates custom fields of a given user.
/users/:userId/customFieldsUpdates custom fields of a given user. - GETReturns custom field of a given user.
/users/:userId/customFields/:customFieldKeyReturns custom field of a given user. - PUTUpdates given custom field of a given user.
/users/:userId/customFields/:customFieldKeyUpdates given custom field of a given user. - PUTSets user's password to a new value.
/users/:userId/passwordSets user's password to a new value.
Jobs (Classic)
- GETReturns job details by jobId.
/jobs/:jobIdReturns job details by jobId. - PUTUpdates dates of a given job.
/jobs/:jobId/datesUpdates dates of a given job. - GETReturns list of input and output files of a job.
/jobs/:jobId/filesReturns list of input and output files of a job. - POSTassignFileToJobOutput
/jobs/:jobId/files/output - GETReturns file metadata.
/jobs/:jobId/files/:fileIdReturns file metadata. - PUTUpdates instructions for a job.
/jobs/:jobId/instructionsUpdates instructions for a job. - PUTChanges job status if possible (400 Bad Request is returned otherwise).
/jobs/:jobId/statusChanges job status if possible (400 Bad Request is returned otherwise). The status has to be specified using one of the following keys:<ul><li>OPEN –… - PUTAssigns vendor to a job in a project.
/jobs/:jobId/vendorAssigns vendor to a job in a project.
Projects (Classic)
- POSTCreates a new Classic Project.
/projectsCreates a new Classic Project. If the specified service ID refers to Smart Project, 400 Bad Request is returned instead. - GETDownloads a file.
/projects/files/:fileId/downloadDownloads a file. - GETReturns projects' internal identifiers.
/projects/ids?updatedSince=0Returns projects' internal identifiers. - GETReturns project details.
/projects/:projectId?embed=stringReturns project details. If the specified project ID refers to Smart Project, 400 Bad Request is returned instead. - DELETERemoves a project.
/projects/:projectIdRemoves a project. - GETReturns contacts of a given project.
/projects/:projectId/contactsReturns contacts of a given project. - PUTUpdates contacts of a given project.
/projects/:projectId/contactsUpdates contacts of a given project. - GETReturns custom fields of a given project.
/projects/:projectId/customFieldsReturns custom fields of a given project. - PUTUpdates custom fields of a given project.
/projects/:projectId/customFieldsUpdates custom fields of a given project. - GETReturns dates of a given project.
/projects/:projectId/datesReturns dates of a given project. - PUTUpdates dates of a given project.
/projects/:projectId/datesUpdates dates of a given project. - GETReturns finance of a given project.
/projects/:projectId/financeReturns finance of a given project. - POSTAdds a payable to a project.
/projects/:projectId/finance/payablesAdds a payable to a project. - PUTUpdates a payable.
/projects/:projectId/finance/payables/:payableIdUpdates a payable. - DELETEDeletes a payable.
/projects/:projectId/finance/payables/:payableIdDeletes a payable. - POSTAdds a receivable to a project.
/projects/:projectId/finance/receivablesAdds a receivable to a project. - PUTUpdates a receivable.
/projects/:projectId/finance/receivables/:receivableIdUpdates a receivable. - DELETEDeletes a receivable.
/projects/:projectId/finance/receivables/:receivableIdDeletes a receivable. - GETReturns instructions of a given project.
/projects/:projectId/instructionsReturns instructions of a given project. - PUTUpdates instructions of a given project.
/projects/:projectId/instructionsUpdates instructions of a given project. - POSTCreates a new language combination for a given project without creating a task.
/projects/:projectId/languageCombinationsCreates a new language combination for a given project without creating a task. - POSTCreates a new task for a given project.
/projects/:projectId/tasksCreates a new task for a given project.<p> Required fields: <ul> <li>languageCombination</li> <li>specializationId</li> <li>workflowId</li> </ul> </p>
Quotes (Classic)
- GETReturns quotes' internal identifiers.
/quotes/ids?updatedSince=0Returns quotes' internal identifiers. - GETReturns quote details.
/quotes/:quoteId?embed=stringReturns quote details. If the specified quote ID refers to Smart Quote, 400 Bad Request is returned instead. - DELETERemoves a quote.
/quotes/:quoteIdRemoves a quote. - POSTSends a quote for customer confirmation.
/quotes/:quoteId/confirmation/sendSends a quote for customer confirmation. Quote status is changed to SENT and a document is sent to the customer. - GETReturns custom fields of a given quote.
/quotes/:quoteId/customFieldsReturns custom fields of a given quote. - PUTUpdates custom fields of a given quote.
/quotes/:quoteId/customFieldsUpdates custom fields of a given quote. - GETReturns dates of a given quote.
/quotes/:quoteId/datesReturns dates of a given quote. - GETReturns finance of a given quote.
/quotes/:quoteId/financeReturns finance of a given quote. - POSTAdds a payable.
/quotes/:quoteId/finance/payablesAdds a payable. - PUTUpdates a payable.
/quotes/:quoteId/finance/payables/:payableIdUpdates a payable. - DELETEDeletes a payable.
/quotes/:quoteId/finance/payables/:payableIdDeletes a payable. - POSTAdds a receivable.
/quotes/:quoteId/finance/receivablesAdds a receivable. - PUTUpdates a receivable.
/quotes/:quoteId/finance/receivables/:receivableIdUpdates a receivable. - DELETEDeletes a receivable.
/quotes/:quoteId/finance/receivables/:receivableIdDeletes a receivable. - GETReturns instructions of a given quote.
/quotes/:quoteId/instructionsReturns instructions of a given quote. - PUTUpdates instructions of a given quote.
/quotes/:quoteId/instructionsUpdates instructions of a given quote. - POSTCreates a new language combination for a given quote without creating a task.
/quotes/:quoteId/languageCombinationsCreates a new language combination for a given quote without creating a task. - POSTStarts a quote.
/quotes/:quoteId/startStarts a quote. - POSTCreates a new task for a given quote.
/quotes/:quoteId/tasksCreates a new task for a given quote. Required fields are presented in the example.
Tasks (Classic)
- DELETERemoves a task.
/tasks/:taskId?removeFilesFromDisc=true&removeExternalProjects=true&forceJobsRemoval=trueRemoves a task. - PUTUpdates Client Task PO Number of a given task.
/tasks/:taskId/clientTaskPONumberUpdates Client Task PO Number of a given task. - GETReturns contacts of a given task.
/tasks/:taskId/contactsReturns contacts of a given task. - PUTUpdates contacts of a given task.
/tasks/:taskId/contactsUpdates contacts of a given task. - GETReturns custom fields of a given task.
/tasks/:taskId/customFieldsReturns custom fields of a given task. - PUTUpdates custom fields of a given task.
/tasks/:taskId/customFieldsUpdates custom fields of a given task. - GETReturns dates of a given task.
/tasks/:taskId/datesReturns dates of a given task. - PUTUpdates dates of a given task.
/tasks/:taskId/datesUpdates dates of a given task. - GETReturns lists of files of a given task.
/tasks/:taskId/filesReturns several lists of files for a given task: input files divided by type, output files, bundles, files per job, preview files. - POSTAdds files to a given task.
/tasks/:taskId/files/inputAdds files to a given task. - GETReturns instructions of a given task.
/tasks/:taskId/instructionsReturns instructions of a given task. - PUTUpdates instructions of a given task.
/tasks/:taskId/instructionsUpdates instructions of a given task. - PUTUpdates name of a given task.
/tasks/:taskId/nameUpdates name of a given task. - GETReturns progress of a given task.
/tasks/:taskId/progressReturns progress of a given task. Progress contains information about task's status (ie. opened or ready) and current phase (ie. translation). Workflow phase… - POSTStarts a task.
/tasks/:taskId/startStarts a task.
Jobs (Smart)(v2)
- GETgetByExternalId
/v2/jobs/for-external-id?externalProjectId=string&externalId=string - GETReturns details for a job.
/v2/jobs/:jobIdReturns details for a job. - PUTUpdates dates of a given job.
/v2/jobs/:jobId/datesUpdates dates of a given job. - POSTaddExternalFileLink
/v2/jobs/:jobId/files/addExternalLink - GETReturns list of files delivered in the job.
/v2/jobs/:jobId/files/deliveredReturns list of files delivered in the job. - PUTAdds files to the project as delivered in the job.
/v2/jobs/:jobId/files/delivered/addAdds files to the project as delivered in the job. The files have to be uploaded beforehand (see "POST /jobs/{jobId}/files/upload" operation). The following… - POSTAdds file link to the project as a link delivered in the job.
/v2/jobs/:jobId/files/delivered/addLinkAdds file link to the project as a link delivered in the job. The following properties can be specified for each file link:<ul><li>url (required, 400 Bad… - POSTUploads file to the project as a file delivered in the job.
/v2/jobs/:jobId/files/delivered/uploadUploads file to the project as a file delivered in the job. Only one file can be uploaded at once. When the upload is finished the file has to be added by… - GETReturns list of files shared with the job as Reference Files.
/v2/jobs/:jobId/files/sharedReferenceFilesReturns list of files shared with the job as Reference Files. - PUTShares selected files as Reference Files with a job in a project.
/v2/jobs/:jobId/files/sharedReferenceFiles/shareShares selected files as Reference Files with a job in a project. The files and the job have to be part of the same project. The operation is finished… - GETReturns list of files shared with the job as Work Files.
/v2/jobs/:jobId/files/sharedWorkFilesReturns list of files shared with the job as Work Files. - PUTShares selected files as Work Files with a job in a project.
/v2/jobs/:jobId/files/sharedWorkFiles/shareShares selected files as Work Files with a job in a project. The files and the job have to be part of the same project. The operation is finished successfully… - PUTStops sharing selected files with a job in a project.
/v2/jobs/:jobId/files/stopSharingStops sharing selected files with a job in a project. The files and the job have to be part of the same project. The operation is finished successfully even… - PUTUpdates instructions for a job.
/v2/jobs/:jobId/instructionsUpdates instructions for a job. See also "PUT /projects/{projectId}/vendorInstructions" and "PUT /quotes/{quoteId}/vendorInstructions" for updating… - PUTChanges job status if possible (400 Bad Request is returned otherwise).
/v2/jobs/:jobId/statusChanges job status if possible (400 Bad Request is returned otherwise). The status has to be specified using one of the following keys:<ul><li>OPEN –… - PUTAssigns vendor to a job in a project.
/v2/jobs/:jobId/vendorAssigns vendor to a job in a project.
Projects (Smart)(v2)
- POSTCreates a new Smart Project.
/v2/projectsCreates a new Smart Project. If the specified service ID refers to Classic Project, 400 Bad Request is returned instead. - POSTPrepares a ZIP archive that contains the specified files.
/v2/projects/files/archivePrepares a ZIP archive that contains the specified files. - GETReturns details of a file.
/v2/projects/files/:fileIdReturns details of a file. - GETDownloads a file content.
/v2/projects/files/:fileId/download/:fileNameDownloads a file content. - GETReturns project details.
/v2/projects/for-external-id/:externalProjectIdReturns project details. - GETReturns project details.
/v2/projects/:projectIdReturns project details. If the specified project ID refers to Classic Project, 400 Bad Request is returned instead. - POSTReturns process id.
/v2/projects/:projectId/addJob - GETReturns if cat tool project is created or queued.
/v2/projects/:projectId/catToolProject - GETReturns Client Contacts information for a project.
/v2/projects/:projectId/clientContactsReturns Client Contacts information for a project - PUTUpdates Client Contacts for a project.
/v2/projects/:projectId/clientContactsUpdates Client Contacts for a project. - PUTUpdates Client Deadline for a project.
/v2/projects/:projectId/clientDeadlineUpdates Client Deadline for a project. - PUTUpdates Client Notes for a project.
/v2/projects/:projectId/clientNotesUpdates Client Notes for a project. - PUTUpdates Client Reference Number for a project.
/v2/projects/:projectId/clientReferenceNumberUpdates Client Reference Number for a project. - GETReturns a list of custom field keys and values for a project.
/v2/projects/:projectId/customFieldsReturns a list of custom field keys and values for a project. - PUTUpdates a custom field with a specified key in a project
/v2/projects/:projectId/customFields/:keyUpdates a custom field with a specified key in a project - GETReturns list of files in a project.
/v2/projects/:projectId/filesReturns list of files in a project. Only files added to the project (i.e. files that have assigned category and languages) are listed. - PUTAdds files to the project as added by PM.
/v2/projects/:projectId/files/addAdds files to the project as added by PM. The files have to be uploaded beforehand (see "POST /v2/projects/{projectId}/files/upload" operation). The following… - POSTaddExternalFileLinks
/v2/projects/:projectId/files/addExternalLink - POSTAdds file links to the project as added by PM.
/v2/projects/:projectId/files/addLinkAdds file links to the project as added by PM. The following properties can be specified for each file link:<ul><li>url (required, 400 Bad Request is returned… - GETReturns list of files in a project, that are ready to be delivered to client.
/v2/projects/:projectId/files/deliverableReturns list of files in a project, that are ready to be delivered to client. A file is considered deliverable to client when all of the following criteria… - POSTUploads file to the project as a file uploaded by PM.
/v2/projects/:projectId/files/uploadUploads file to the project as a file uploaded by PM. Only one file can be uploaded at once. When the upload is finished the file has to be added by… - GETReturns finance information for a project.
/v2/projects/:projectId/financeReturns finance information for a project. - POSTAdds a payable to a project.
/v2/projects/:projectId/finance/payablesAdds a payable to a project. - PUTUpdates a payable.
/v2/projects/:projectId/finance/payables/:payableIdUpdates a payable. - DELETEDeletes a payable.
/v2/projects/:projectId/finance/payables/:payableIdDeletes a payable. - POSTAdds a receivable to a project.
/v2/projects/:projectId/finance/receivablesAdds a receivable to a project. - PUTUpdates a receivable.
/v2/projects/:projectId/finance/receivables/:receivableIdUpdates a receivable. - DELETEDeletes a receivable.
/v2/projects/:projectId/finance/receivables/:receivableIdDeletes a receivable. - PUTUpdates Internal Notes for a project.
/v2/projects/:projectId/internalNotesUpdates Internal Notes for a project. - GETReturns list of jobs in a project.
/v2/projects/:projectId/jobsReturns list of jobs in a project. - PUTUpdates Order Date for a project.
/v2/projects/:projectId/orderDateUpdates Order Date for a project. - GETReturns process id.
/v2/projects/:projectId/process - PUTUpdates source language for a project.
/v2/projects/:projectId/sourceLanguageUpdates source language for a project. - PUTUpdates specialization for a project.
/v2/projects/:projectId/specializationUpdates specialization for a project. - PUTChanges project status if possible (400 Bad Request is returned otherwise).
/v2/projects/:projectId/statusChanges project status if possible (400 Bad Request is returned otherwise). The status has to be specified using one of the following keys: <ul><li>CANCELLED… - PUTUpdates target languages for a project.
/v2/projects/:projectId/targetLanguagesUpdates target languages for a project. - PUTUpdates instructions for all vendors performing the jobs in a project.
/v2/projects/:projectId/vendorInstructionsUpdates instructions for all vendors performing the jobs in a project. See also "PUT /jobs/{jobId}/instructions" for updating instructions for a specific job… - PUTUpdates volume for a project.
/v2/projects/:projectId/volumeUpdates volume for a project.
Quotes (Smart)(v2)
- POSTCreates a new Smart Quote.
/v2/quotesCreates a new Smart Quote. If the specified service ID refers to Classic Quote, 400 Bad Request is returned instead. - POSTPrepares a ZIP archive that contains the specified files.
/v2/quotes/files/archivePrepares a ZIP archive that contains the specified files. - GETReturns details of a file.
/v2/quotes/files/:fileIdReturns details of a file. - GETDownloads a file content.
/v2/quotes/files/:fileId/download/:fileNameDownloads a file content. - GETReturns quote details.
/v2/quotes/:quoteIdReturns quote details. If the specified quote ID refers to Classic Quote, 400 Bad Request is returned instead. - PUTUpdates Business Days for a quote.
/v2/quotes/:quoteId/businessDaysUpdates Business Days for a quote. - GETReturns Client Contacts information for a quote.
/v2/quotes/:quoteId/clientContactsReturns Client Contacts information for a quote. - PUTUpdates Client Contacts for a quote.
/v2/quotes/:quoteId/clientContactsUpdates Client Contacts for a quote. - PUTUpdates Client Notes for a quote.
/v2/quotes/:quoteId/clientNotesUpdates Client Notes for a quote. - PUTUpdates Client Reference Number for a quote.
/v2/quotes/:quoteId/clientReferenceNumberUpdates Client Reference Number for a quote. - GETReturns a list of custom field keys and values for a project.
/v2/quotes/:quoteId/customFieldsReturns a list of custom field keys and values for a project. - PUTUpdates a custom field with a specified key in a quote.
/v2/quotes/:quoteId/customFields/:keyUpdates a custom field with a specified key in a quote. - PUTUpdates Expected Delivery Date for a quote.
/v2/quotes/:quoteId/expectedDeliveryDateUpdates Expected Delivery Date for a quote. - GETReturns list of files in a quote.
/v2/quotes/:quoteId/filesReturns list of files in a quote. Only files added to the quote (i.e. files that have assigned category and languages) are listed. - PUTAdds files to the quote as added by PM.
/v2/quotes/:quoteId/files/addAdds files to the quote as added by PM. The files have to be uploaded beforehand (see "POST v2/quotes/{quoteId}/files/upload" operation). The following… - POSTUploads file to the quote as a file uploaded by PM.
/v2/quotes/:quoteId/files/uploadUploads file to the quote as a file uploaded by PM. Only one file can be uploaded at once. When the upload is finished the file has to be added by specifying… - GETReturns finance information for a quote.
/v2/quotes/:quoteId/financeReturns finance information for a quote. - POSTAdds a payable to a quote.
/v2/quotes/:quoteId/finance/payablesAdds a payable to a quote. - PUTUpdates a payable.
/v2/quotes/:quoteId/finance/payables/:payableIdUpdates a payable. - DELETEDeletes a payable.
/v2/quotes/:quoteId/finance/payables/:payableIdDeletes a payable. - POSTAdds a receivable to a quote.
/v2/quotes/:quoteId/finance/receivablesAdds a receivable to a quote. - PUTUpdates a receivable.
/v2/quotes/:quoteId/finance/receivables/:receivableIdUpdates a receivable. - DELETEDeletes a receivable.
/v2/quotes/:quoteId/finance/receivables/:receivableIdDeletes a receivable. - PUTUpdates Internal Notes for a quote.
/v2/quotes/:quoteId/internalNotesUpdates Internal Notes for a quote. - GETReturns list of jobs in a quote.
/v2/quotes/:quoteId/jobsReturns list of jobs in a quote. - PUTUpdates Quote Expiry Date for a quote.
/v2/quotes/:quoteId/quoteExpiryUpdates Quote Expiry Date for a quote. - PUTUpdates source language for a quote.
/v2/quotes/:quoteId/sourceLanguageUpdates source language for a quote. - PUTUpdates specialization for a quote.
/v2/quotes/:quoteId/specializationUpdates specialization for a quote. - PUTChanges quote status if possible (400 Bad Request is returned otherwise).
/v2/quotes/:quoteId/statusChanges quote status if possible (400 Bad Request is returned otherwise). The status has to be specified using one of the following keys: <ul><li>PENDING –… - PUTUpdates target languages for a quote.
/v2/quotes/:quoteId/targetLanguagesUpdates target languages for a quote. - PUTUpdates instructions for all vendors performing the jobs in a quote.
/v2/quotes/:quoteId/vendorInstructionsUpdates instructions for all vendors performing the jobs in a quote. See also "PUT /jobs/{jobId}/instructions" for updating instructions for a specific job in… - PUTUpdates volume for a quote.
/v2/quotes/:quoteId/volumeUpdates volume for a quote.
API details
- Base URL
https://presentation.s.xtrf.eu/home-api- Authentication
- An API key in the X-AUTH-ACCESS-TOKEN header
- Operations
- 284 operations on 224 pathsGET 117PUT 86POST 56DELETE 25
- Main resources
- Projects (Smart)(v2) 38Quotes (Smart)(v2) 32Clients 31Browser 26Projects (Classic) 22Quotes (Classic) 19Client Invoices 16Jobs (Smart)(v2) 16Vendors 16Tasks (Classic) 15
- Response formats
application/vnd.xtrf-v1+json;charset=utf-8application/json;charset=utf-8application/jsonmultipart/form-data- Description format
- OpenAPI 3.0.1, API version
2.0 - Links
- OpenAPI document · Terms of service
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the XTRF Home Portal API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the XTRF Home Portal API collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the X-AUTH-ACCESS-TOKEN header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Searches for data (ie. customer, task, etc) and returns it in a tabular form.” (GET /browser?viewId=0&page=0&additionalOrder=string&useDeferredColumns=string&maxRows=0), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the XTRF Home Portal API?
XTRF Home Portal API enables you to perform operations on Projects, Quotes, Customers, Vendors etc. as a XTRF Home Portal user. The documentation is generated… It is listed under Other and has 284 endpoints.
Who publishes the XTRF Home Portal API?
It is listed from Xtrf's public API description (an OpenAPI document), not published by Xtrf on Swastik Codes. Anyone who controls xtrf.eu can claim the profile by adding a DNS TXT record.
What is the base URL of the XTRF Home Portal API?
Requests go to https://presentation.s.xtrf.eu/home-api. Endpoint paths are added to this base URL.
How do I authenticate with the XTRF Home Portal API?
With an API key in the X-AUTH-ACCESS-TOKEN header.
How many endpoints does the XTRF Home Portal API have?
284 operations on 224 paths (117 GET, 86 PUT, 56 POST, 25 DELETE). The largest groups are Projects (Smart)(v2), Quotes (Smart)(v2), Clients, Browser.
Is forking the XTRF Home Portal API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.