Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Workist Master Data API

The Master Data API from Workist — 12 operation(s) for master data.

Workist Master Data API is one of 8 APIs that Workist publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Master Data. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.

This API exposes 13 operations across 12 paths, and defines 21 schemas. It is described by OpenAPI 3.0.3, at version v1.

Requests are made against 2 base URLs: /v1/, /api/v1/.

13 operations 12 paths 21 schemas 2 GET11 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
v1
Base URL
https://api.workist.com/api/v1
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Workist Master Data API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuthentication).

Paths & Operations 13

Across 12 paths, the API surfaces 13 operations — 2 GET, 11 POST. Each is listed below with its method, path, parameters, and response codes.

Master Data 13
POST
/master-data/addresses/imports
Create a new master data import
addresses_imports_create body → 202400401404500
POST
/master-data/articles/imports
Create a new master data import
articles_imports_create body → 202400401404500
POST
/master-data/clients/imports
Create a new master data import
clients_imports_create body → 202400401404500
POST
/master-data/contacts/imports
Create a new master data import
contacts_imports_create body → 202400401404500
POST
/master-data/conversion-factors/imports
Create a new master data import
conversion_factors_imports_create body → 202400401404500
POST
/master-data/framework-contracts/imports
Create a new master data import
framework_contracts_imports_create body → 202400401404500
GET
/master-data/imports
Get all master data import runs
imports_list 2 params → 200400401404500
POST
/master-data/imports
Create a new master data import
imports_create body → 202400401404500
GET
/master-data/imports/{id}
Get a specific master data import run
imports_retrieve 1 param → 200400401404500
POST
/master-data/imports/{id}/data
Append a batch of data to a batched import
imports_data_create 1 param body → 202400401404500
POST
/master-data/imports/{id}/start
Start the batched import & ingest all associated data
imports_start_create 1 param → 202400401404500
POST
/master-data/offer-matching/imports
Create a new master data import
offer_matching_imports_create body → 202400401404500
POST
/master-data/order-matching/imports
Create a new master data import
order_matching_imports_create body → 202400401404500

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are ClientMasterData (30 properties), OrderMatchingMasterData (23 properties), AddressMasterData (18 properties), DataImportRun (14 properties). Each schema is shown below with its type and property counts.

AcceptedResponse
object
1 property 1 required
PaginatedDataImportRunList
object
4 properties 2 required
DataImportRun
object
14 properties 6 required
ContactMasterDataImportRequest
object
5 properties 1 required
DataRequest
object
3 properties
ConversionFactorMasterDataImportRequest
object
5 properties 1 required
ClientMasterDataImportRequest
object
5 properties 1 required
ArticleMasterDataImportRequest
object
5 properties 1 required
FrameworkContractMasterDataImportRequest
object
5 properties 1 required
FrameworkContractMasterData
object
7 properties 1 required
ClientMasterData
object
30 properties 1 required
AddressMasterDataImportRequest
object
5 properties 1 required
ArticleMasterData
object
12 properties 1 required
ImportRequest
object
5 properties 1 required
ConversionFactorMasterData
object
6 properties 2 required
AddressMasterData
object
18 properties 1 required
OfferMatchingMasterDataImportRequest
object
5 properties 1 required
OrderMatchingMasterDataImportRequest
object
5 properties 1 required
OrderMatchingMasterData
object
23 properties 2 required
OfferMatchingMasterData
object
12 properties 2 required
ContactMasterData
object
7 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

workist-master-data-api-openapi.yml Raw ↑

Other APIs Workist publishes across the network.

Workist Delivery Notes API
Workist Invoices API
Workist List Of Services API
Workist Order Confirmations API
Workist Orders API
Workist Property Bills API
Workist Rfq API