Seamless API
AI translated from the German original
Integrate Seamless into your own systems.
With the Seamless REST API, you integrate Seamless into your own systems. A project portal or an ERP then automatically creates a workspace for every new project, for example, using the same templates, names and rules as in the Seamless App.
Basics
Section titled “Basics”| Topic | Value |
|---|---|
| Base URL | https://sml-api.io |
| Format | JSON |
| Authentication | Bearer token in the Authorization header, valid for 24 hours |
Authorization: Bearer eyJ0eXAiOiJKV1Qi...You get the token with an API key, see Get an access token.
Identifiers instead of IDs
Section titled “Identifiers instead of IDs”Instead of IDs, you can also address organisations and templates by their identifier. This is a readable short name (slug), e.g. contoso for the organisation or prj for the template. You enter it in the Admin Center for the organisation and in the General tab of the template.
This simplifies the integration when many organisations use the same templates. If, for example, you enter the project template as prj in all organisations, the calling system only selects the organisation. The template is always prj.
| organisationIdOrIdentifier | templateIdOrIdentifier |
|---|---|
finance |
prj |
marketing |
prj |
it |
prj |
Examples
Section titled “Examples”All examples are available for cURL, PowerShell and C#. The selected language applies on all pages.
- cURL: The token is in
$TOKEN. - PowerShell: The header is in
$headers, see Get an access token. - C#:
httpis anHttpClientwith base URL and token, see Get an access token.
In the examples, we create the workspace 260215.001 - Project Atlas in the organisation Contoso with the template Project.
Endpoints
Section titled “Endpoints”| Endpoint | Purpose |
|---|---|
POST /token |
Get an access token |
GET /organisations |
List all organisations |
GET /organisations/{idOrIdentifier} |
Get an organisation with its templates |
POST /teams |
Create a workspace from a template |
PATCH /teams/{teamId}/name |
Rename a workspace |
The project workspace guide shows how the endpoints work together.