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 List Of Services API

The List Of Services API from Workist — 6 operation(s) for list of services.

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

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

This API exposes 8 operations across 6 paths, and defines 18 schemas. It is described by OpenAPI 3.0.3, at version v1.

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

8 operations 6 paths 18 schemas 1 DELETE2 GET1 PATCH2 POST2 PUT

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 List Of Services API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuthentication).

Paths & Operations 8

Across 6 paths, the API surfaces 8 operations — 1 DELETE, 2 GET, 1 PATCH, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

List Of Services 8
GET
/list-of-services
Get all processing records for this document type
list_of_services_list 12 params → 200400401404500
POST
/list-of-services
Add a new processing record for this document type
list_of_services_create 1 param body → 201400401404500
GET
/list-of-services/{id}
Get a specific processing record for this document type
list_of_services_retrieve 2 params → 200400401404500
DELETE
/list-of-services/{id}
Delete a processing record of this document type
list_of_services_destroy 1 param → 204400401404500
PUT
/list-of-services/{id}/assign_user
Assign a user to a specific processing record of this document type
list_of_services_assign_user_update 2 params body → 200400401404500
POST
/list-of-services/{id}/generate-x94
Generate a new list of services
list_of_services_generate_x94_create 1 param body → 200400401404500
PUT
/list-of-services/{id}/mark_imported
Mark a processing record of this document type as imported
list_of_services_mark_imported_update 2 params body → 200400401404500
PATCH
/list-of-services/{id}/meta
Update the meta information of a processing record of this document type
list_of_services_meta_partial_update 2 params body → 200400401404500

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are ListOfServicesProcessingRecord (23 properties), Address (18 properties), X94ListOfServicesArticleItemRequest (12 properties), ListOfServices (12 properties). Each schema is shown below with its type and property counts.

GenerateX94ListOfServicesRequest
object
2 properties 2 required
MarkImportedRequest
object
4 properties
ListOfServicesPosition
object
5 properties
ListOfServicesProcessingRecord
object
23 properties 19 required
PatchedMetaRequest
object
2 properties
X94ListOfServicesSupplierInfoRequest
object
4 properties
CreateDocumentRequest
object
3 properties 2 required
ContactPerson
object
4 properties
ListOfServicesArticleSet
object
2 properties
ListOfServicesArticle
object
6 properties
AssignUserRequest
object
1 property 1 required
X94ListOfServicesAddressRequest
object
5 properties
Address
object
18 properties
ListOfServices
object
12 properties
X94ListOfServicesArticleItemRequest
object
12 properties 1 required
User
object
3 properties 1 required
PaginatedListOfServicesProcessingRecordList
object
4 properties 2 required
Customer
object
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

workist-list-of-services-api-openapi.yml Raw ↑

Other APIs Workist publishes across the network.

Workist Delivery Notes API
Workist Invoices API
Workist Master Data API
Workist Order Confirmations API
Workist Orders API
Workist Property Bills API
Workist Rfq API