OutSmart API

Integrate external software with OutSmart using the OpenAPI.

The OutSmart API, also called the WorkorderApp API, connects external software with OutSmart.

Use it to synchronise materials, categories, contacts, projects, hour types, and forms. You can also retrieve work orders from OutSmart.

This API is for developers and technical integration partners.

Base URL: https://app.out-smart.com/openapi/8

For endpoints, request bodies, required fields, and response examples, see the OutSmart API reference.

Authentication

Send your account token as a bearer token with every request.

The token belongs to an OutSmart customer with a registered external-software license. OutSmart verifies that the requesting software package matches the token.

Generate an account token under Settings → Software integrations.

Use HTTPS for every request. OutSmart rejects plain HTTP requests.

How responses work

Every response is a JSON object with these fields:

Field	Type	Description
code	number	Response code for the executed request.
messages	array of strings	Details about the request result.
response	object	The response payload.

A code of 200 indicates success. Other codes identify issues such as missing fields, invalid tokens, or malformed request bodies.

See the OutSmart API reference for all response codes.

{ "code": 1001, "messages": [], "response": null }

Advanced filtering

Most GET endpoints support filters through URL parameters.

&key=key1&value=value1&operator=eq

To combine filters, repeat each parameter:

&key[]=key1&value[]=value1&operator[]=eq&key[]=key2&value[]=value2&operator[]=gt

Operator	Meaning
li	Like (%)
eq	Equal (=)
ne	Not equal (!=)
gt	Greater than (>)
ge	Greater than or equal (>=)
lt	Less than (<)
le	Less than or equal (<=)

What you can sync

The API includes endpoints for these resources:

• Materials — product and material records.
• Material translations — multilingual material names.
• Categories and material categories — material classifications.
• Relations — external contacts and customers.
• Projects — external project records.
• Hour types — labour categories and pricing.
• Forms — custom forms, including signatures and choice fields.
• Work orders — create, update, and retrieve work orders.

Each resource has its own fields and supported operations. See the OutSmart API reference for implementation details.

Typical work order workflow

Use this flow when your integration processes completed work orders.

1

Synchronise dependencies

Synchronise materials, relations, categories, and other required entities first.

2

Create or update work orders

Create work orders with PostWorkorders.

Update them with UpdateWorkorder.

3

Retrieve completed work

Use GetWorkorders with the status Compleet.

Set update_status=false to keep the status unchanged.

4

Process the work order

Process each work order with status Compleet in your system.

Handle processing errors and notify the relevant user.

5

Mark successful processing

Call GetWorkorder with update_status=true after successful processing.

The work order status becomes Afgehandeld. It no longer appears in later GetWorkorders calls.

Work order statuses

Status	Meaning
Klaargezet	Created and ready for device retrieval when an employee is assigned.
Opgehaald	Retrieved on a device and ready for employee completion.
Compleet	Completed and sent to the back office for administrative processing.
Afgehandeld	Administratively processed.

Next steps

Open the OutSmart API reference for the complete endpoint catalogue and request examples.