User Management (Core)

These endpoints enable the administration of user accounts, including creation, updating, read and deletion of user accounts.

List permissions

get

This endpoint returns all available permissions in the FFT platform.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

sizenumber · min: 1 · max: 100OptionalDefault: 25

startAfterIdstringOptional

keystring · enumOptional

The key of the permission to filter by

Possible values:

groupstring · enumOptional

The group of the permission to filter by

Possible values:

Responses

200

The Permissions

application/json

PermissionsResponse

totalnumberRequired

The total number of (filtered) permissions

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this

application/json

get

/api/permissions

GET /api/permissions HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "permissions": [
    {
      "description": "text",
      "group": "INVENTORY",
      "key": "USER_READ",
      "operation": "READ",
      "subGroup": "ORDER"
    }
  ],
  "total": 1
}

List roles

get

Returns all existing roles, including their permissions and context ceilings.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

The requested roles.

application/json

Role

createdstring · date-timeRequired

The date when the role was created.

customAttributesobjectOptional

The custom attributes of the role, which can be used to store additional information.

descriptionstring · max: 100Optional

The description of the role, which provides more details about its purpose.

displayNamestring · max: 50Optional

The display name of the role, which is used for user interfaces and may differ from the name (defaults to name if not provided).

lastModifiedstring · date-timeRequired

The date when the role was last modified.

namestring · min: 3 · max: 20Required

The name of the role, which must be unique and is used to identify the role.

versionnumberRequired

The version of the role.

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this

application/json

get

/api/roles

GET /api/roles HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "contexts": [
      {
        "type": "FACILITY",
        "values": [
          "text"
        ]
      }
    ],
    "created": "2026-03-13T15:49:20.185Z",
    "customAttributes": {},
    "description": "text",
    "displayName": "text",
    "lastModified": "2026-03-13T15:49:20.185Z",
    "name": "text",
    "permissions": [
      "USER_READ"
    ],
    "version": 1
  }
]

Create role

post

Creates a new custom role.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

RoleForCreation

customAttributesobjectOptional

The custom attributes of the role, which can be used to store additional information.

descriptionstring · max: 100Optional

The description of the role, which provides more details about its purpose.

displayNamestring · max: 50Optional

The display name of the role, which is used for user interfaces and may differ from the name (defaults to name if not provided).

namestring · min: 3 · max: 20Required

The name of the role, which must be unique and is used to identify the role.

Responses

201

The created role.

application/json

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this

application/json

post

/api/roles

POST /api/roles HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 158

{
  "contexts": [
    {
      "type": "FACILITY",
      "values": [
        "text"
      ]
    }
  ],
  "customAttributes": {},
  "description": "text",
  "displayName": "text",
  "name": "text",
  "permissions": [
    "USER_READ"
  ]
}

{
  "contexts": [
    {
      "type": "FACILITY",
      "values": [
        "text"
      ]
    }
  ],
  "created": "2026-03-13T15:49:20.185Z",
  "customAttributes": {},
  "description": "text",
  "displayName": "text",
  "lastModified": "2026-03-13T15:49:20.185Z",
  "name": "text",
  "permissions": [
    "USER_READ"
  ],
  "version": 1
}

Return role

get

Returns a role requested by its name.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

namestringRequired

Responses

200

The requested role.

application/json

Role

createdstring · date-timeRequired

The date when the role was created.

customAttributesobjectOptional

The custom attributes of the role, which can be used to store additional information.

descriptionstring · max: 100Optional

The description of the role, which provides more details about its purpose.

displayNamestring · max: 50Optional

The display name of the role, which is used for user interfaces and may differ from the name (defaults to name if not provided).

lastModifiedstring · date-timeRequired

The date when the role was last modified.

namestring · min: 3 · max: 20Required

The name of the role, which must be unique and is used to identify the role.

versionnumberRequired

The version of the role.

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this

application/json

404

The requested entity was not found

application/json

get

/api/roles/{name}

GET /api/roles/{name} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "contexts": [
    {
      "type": "FACILITY",
      "values": [
        "text"
      ]
    }
  ],
  "created": "2026-03-13T15:49:20.185Z",
  "customAttributes": {},
  "description": "text",
  "displayName": "text",
  "lastModified": "2026-03-13T15:49:20.185Z",
  "name": "text",
  "permissions": [
    "USER_READ"
  ],
  "version": 1
}

Update role

put

Updates an existing role (complete replacement).

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

namestringRequired

Body

RoleForUpdate

customAttributesobjectOptional

The custom attributes of the role, which can be used to store additional information.

descriptionstring · max: 100Optional

The description of the role, which provides more details about its purpose.

displayNamestring · max: 50Optional

The display name of the role, which is used for user interfaces and may differ from the name (defaults to name if not provided).

namestring · min: 3 · max: 20Required

The name of the role, which must be unique and is used to identify the role.

versionnumberRequired

The version of the role.

Responses

200

The updated role, including all the updates made.

application/json

Role

createdstring · date-timeRequired

The date when the role was created.

customAttributesobjectOptional

The custom attributes of the role, which can be used to store additional information.

descriptionstring · max: 100Optional

The description of the role, which provides more details about its purpose.

displayNamestring · max: 50Optional

The display name of the role, which is used for user interfaces and may differ from the name (defaults to name if not provided).

lastModifiedstring · date-timeRequired

The date when the role was last modified.

namestring · min: 3 · max: 20Required

The name of the role, which must be unique and is used to identify the role.

versionnumberRequired

The version of the role.

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this

application/json

404

The requested entity was not found

application/json

put

/api/roles/{name}

PUT /api/roles/{name} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 170

{
  "contexts": [
    {
      "type": "FACILITY",
      "values": [
        "text"
      ]
    }
  ],
  "customAttributes": {},
  "description": "text",
  "displayName": "text",
  "name": "text",
  "permissions": [
    "USER_READ"
  ],
  "version": 1
}

{
  "contexts": [
    {
      "type": "FACILITY",
      "values": [
        "text"
      ]
    }
  ],
  "created": "2026-03-13T15:49:20.185Z",
  "customAttributes": {},
  "description": "text",
  "displayName": "text",
  "lastModified": "2026-03-13T15:49:20.185Z",
  "name": "text",
  "permissions": [
    "USER_READ"
  ],
  "version": 1
}

Delete role

delete

Deletes an existing role.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

namestringRequired

Responses

200

The deleted role.

application/json

Role

createdstring · date-timeRequired

The date when the role was created.

customAttributesobjectOptional

The custom attributes of the role, which can be used to store additional information.

descriptionstring · max: 100Optional

The description of the role, which provides more details about its purpose.

displayNamestring · max: 50Optional

The display name of the role, which is used for user interfaces and may differ from the name (defaults to name if not provided).

lastModifiedstring · date-timeRequired

The date when the role was last modified.

namestring · min: 3 · max: 20Required

The name of the role, which must be unique and is used to identify the role.

versionnumberRequired

The version of the role.

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this

application/json

404

The requested entity was not found

application/json

delete

/api/roles/{name}

DELETE /api/roles/{name} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "contexts": [
    {
      "type": "FACILITY",
      "values": [
        "text"
      ]
    }
  ],
  "created": "2026-03-13T15:49:20.185Z",
  "customAttributes": {},
  "description": "text",
  "displayName": "text",
  "lastModified": "2026-03-13T15:49:20.185Z",
  "name": "text",
  "permissions": [
    "USER_READ"
  ],
  "version": 1
}

Update role

patch

Updates an existing role (partial update).

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

namestringRequired

Body

RoleForPatch

customAttributesobjectOptional

The custom attributes of the role, which can be used to store additional information.

descriptionstring · max: 100Optional

The description of the role, which provides more details about its purpose.

displayNamestring · max: 100Optional

The display name of the role, which is used for user interfaces and may differ from the name (defaults to name if not provided).

namestringRequired

The name of the role, which must be unique and is used to identify the role.

versionnumberRequired

The version of the role.

Responses

200

The patched role, including all the updates made.

application/json

Role

createdstring · date-timeRequired

The date when the role was created.

customAttributesobjectOptional

The custom attributes of the role, which can be used to store additional information.

descriptionstring · max: 100Optional

The description of the role, which provides more details about its purpose.

displayNamestring · max: 50Optional

The display name of the role, which is used for user interfaces and may differ from the name (defaults to name if not provided).

lastModifiedstring · date-timeRequired

The date when the role was last modified.

namestring · min: 3 · max: 20Required

The name of the role, which must be unique and is used to identify the role.

versionnumberRequired

The version of the role.

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this

application/json

404

The requested entity was not found

application/json

patch

/api/roles/{name}

PATCH /api/roles/{name} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 170

{
  "contexts": [
    {
      "type": "FACILITY",
      "values": [
        "text"
      ]
    }
  ],
  "customAttributes": {},
  "description": "text",
  "displayName": "text",
  "name": "text",
  "permissions": [
    "USER_READ"
  ],
  "version": 1
}

{
  "contexts": [
    {
      "type": "FACILITY",
      "values": [
        "text"
      ]
    }
  ],
  "created": "2026-03-13T15:49:20.185Z",
  "customAttributes": {},
  "description": "text",
  "displayName": "text",
  "lastModified": "2026-03-13T15:49:20.185Z",
  "name": "text",
  "permissions": [
    "USER_READ"
  ],
  "version": 1
}

List roles (search)

post

Search for Role

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

RoleSearchPayload

afterstringOptional

The cursor to start after for forward pagination. The value is provided in the pageInfo.endCursor field of the response. Cannot be used with before or last.

beforestringOptional

The cursor to start before for backward pagination. The value is provided in the pageInfo.startCursor field of the response. Cannot be used with after or size (first).

lastnumber · min: 1 · max: 250Optional

Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.

sizenumber · min: 1 · max: 250Optional

Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.

startAfterIdstringOptionalDeprecated

The ID to start after. Deprecated, use after with the value provided in pageInfo.endCursor instead.

Responses

200

Your search result

application/json

RolePaginatedResult

totalnumberOptional

The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this

application/json

post

/api/roles/search

POST /api/roles/search HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1474

{
  "after": "text",
  "before": "text",
  "last": 1,
  "options": {
    "withTotal": true
  },
  "query": {
    "and": [
      {
        "and": [
          {
            "and": "[Circular Reference]",
            "description": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "displayName": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "name": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "or": "[Circular Reference]"
          }
        ],
        "description": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "displayName": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "name": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "or": [
          {
            "and": "[Circular Reference]",
            "description": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "displayName": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "name": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "or": "[Circular Reference]"
          }
        ]
      }
    ],
    "description": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "displayName": {
      "eq": "text",
      "in": [
        "text"
      ],
      "like": "text",
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "name": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "or": [
      {
        "and": "[Circular Reference]",
        "description": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "displayName": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "name": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "or": "[Circular Reference]"
      }
    ]
  },
  "size": 1,
  "sort": [
    {
      "displayName": "ASC"
    }
  ]
}

{
  "pageInfo": {
    "endCursor": "text",
    "hasNextPage": true,
    "hasPreviousPage": true,
    "startCursor": "text"
  },
  "roles": [
    {
      "contexts": [
        {
          "type": "FACILITY",
          "values": [
            "text"
          ]
        }
      ],
      "created": "2026-03-13T15:49:20.185Z",
      "customAttributes": {},
      "description": "text",
      "displayName": "text",
      "lastModified": "2026-03-13T15:49:20.185Z",
      "name": "text",
      "permissions": [
        "USER_READ"
      ],
      "version": 1
    }
  ],
  "total": 1
}

List users

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

sizenumber · min: 1 · max: 100OptionalDefault: 25

startAfterIdstringOptional

orderBystringOptional

Order the users by this field

facilityIdstringOptional

Filter the users by this facility

includeAdminUsersbooleanOptional

Include all admins in the result (only applicable if facilityId is set)

Responses

200

The users were successfully returned.

application/json

User

authenticationProviderTypestring · enumOptional

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.

ISO 3166 conform country code and ISO 639-1 conform language code (de_DE, en_US, ch_FR, etc.)

Example: de_DEPossible values:

createdstring · date-timeOptional

Creation date of the user

emailstringOptional

The email of the user

Example: [email protected]

facilityLimitationsstring[]Optional

Facilities where at least one role of the user has access to. Not present if the user has at least one role which is unrestricted

firstnamestringRequired

The first name of the user

Example: John

idstringRequired

The id of the user

lastLoginstring · date-timeOptional

The last login timestamp of the user

lastModifiedstring · date-timeOptional

Last modification date of the user

lastnamestringRequired

The last name of the user

Example: Doe

localestring · enumOptional

Example: de_DEPossible values:

usernamestringRequired

The username of the user

Example: johndoe

versionnumberRequired

Version of the user

Example: 1

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this

application/json

404

The requested entity was not found

application/json

get

/api/users

GET /api/users HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "assignedRoles": [
    {
      "context": [
        {
          "type": "FACILITY",
          "values": [
            "text"
          ]
        }
      ],
      "ref": "text"
    }
  ],
  "authenticationProvider": {
    "id": "text",
    "type": "EMAIL_PASSWORD"
  },
  "authenticationProviderType": "de_DE",
  "created": "2026-03-13T15:49:20.185Z",
  "email": "[email protected]",
  "facilityLimitations": [
    "text"
  ],
  "firstname": "John",
  "id": "text",
  "lastLogin": "2026-03-13T15:49:20.185Z",
  "lastModified": "2026-03-13T15:49:20.185Z",
  "lastname": "Doe",
  "locale": "de_DE",
  "username": "johndoe",
  "version": 1
}

Creates user

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

UserForCreation

emailstringOptional

The email of the user

Example: [email protected]

firstnamestringRequired

The first name of the user

Example: John

lastnamestringRequired

The last name of the user

Example: Doe

localestring · enumOptional

Example: de_DEPossible values:

passwordstringRequired

The password of the user

Example: elephantMangoDance123

usernamestringRequired

The username of the user

Example: johndoe

Responses

201

The users was successfully created.

application/json

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this

application/json

404

The requested entity was not found

application/json

post

/api/users

POST /api/users HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 307

{
  "assignedFacilities": [
    {
      "assignedZones": [
        {
          "zoneRef": "text"
        }
      ],
      "facilityRef": "text"
    }
  ],
  "assignedRoles": [
    {
      "context": [
        {
          "type": "FACILITY",
          "values": [
            "text"
          ]
        }
      ],
      "ref": "text"
    }
  ],
  "email": "[email protected]",
  "firstname": "John",
  "lastname": "Doe",
  "locale": "de_DE",
  "password": "elephantMangoDance123",
  "username": "johndoe"
}

{
  "assignedRoles": [
    {
      "context": [
        {
          "type": "FACILITY",
          "values": [
            "text"
          ]
        }
      ],
      "ref": "text"
    }
  ],
  "authenticationProvider": {
    "id": "text",
    "type": "EMAIL_PASSWORD"
  },
  "authenticationProviderType": "de_DE",
  "created": "2026-03-13T15:49:20.185Z",
  "email": "[email protected]",
  "facilityLimitations": [
    "text"
  ],
  "firstname": "John",
  "id": "text",
  "lastLogin": "2026-03-13T15:49:20.185Z",
  "lastModified": "2026-03-13T15:49:20.185Z",
  "lastname": "Doe",
  "locale": "de_DE",
  "username": "johndoe",
  "version": 1
}

Return user

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

userIdstringRequired

Responses

200

The user.

application/json

User

authenticationProviderTypestring · enumOptional

Example: de_DEPossible values:

createdstring · date-timeOptional

Creation date of the user

emailstringOptional

The email of the user

Example: [email protected]

facilityLimitationsstring[]Optional

Facilities where at least one role of the user has access to. Not present if the user has at least one role which is unrestricted

firstnamestringRequired

The first name of the user

Example: John

idstringRequired

The id of the user

lastLoginstring · date-timeOptional

The last login timestamp of the user

lastModifiedstring · date-timeOptional

Last modification date of the user

lastnamestringRequired

The last name of the user

Example: Doe

localestring · enumOptional

Example: de_DEPossible values:

usernamestringRequired

The username of the user

Example: johndoe

versionnumberRequired

Version of the user

Example: 1

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this

application/json

404

The requested entity was not found

application/json

get

/api/users/{userId}

GET /api/users/{userId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "assignedRoles": [
    {
      "context": [
        {
          "type": "FACILITY",
          "values": [
            "text"
          ]
        }
      ],
      "ref": "text"
    }
  ],
  "authenticationProvider": {
    "id": "text",
    "type": "EMAIL_PASSWORD"
  },
  "authenticationProviderType": "de_DE",
  "created": "2026-03-13T15:49:20.185Z",
  "email": "[email protected]",
  "facilityLimitations": [
    "text"
  ],
  "firstname": "John",
  "id": "text",
  "lastLogin": "2026-03-13T15:49:20.185Z",
  "lastModified": "2026-03-13T15:49:20.185Z",
  "lastname": "Doe",
  "locale": "de_DE",
  "username": "johndoe",
  "version": 1
}

Delete user

delete

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

userIdstringRequired

Responses

200

The deleted user.

No content

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this

application/json

404

The requested entity was not found

application/json

delete

/api/users/{userId}

DELETE /api/users/{userId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update user

patch

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

userIdstringRequired

Body

UserPatchActions

versionnumberRequired

The version of the user to modify

Responses

200

The modified user.

application/json

User

authenticationProviderTypestring · enumOptional

Example: de_DEPossible values:

createdstring · date-timeOptional

Creation date of the user

emailstringOptional

The email of the user

Example: [email protected]

facilityLimitationsstring[]Optional

Facilities where at least one role of the user has access to. Not present if the user has at least one role which is unrestricted

firstnamestringRequired

The first name of the user

Example: John

idstringRequired

The id of the user

lastLoginstring · date-timeOptional

The last login timestamp of the user

lastModifiedstring · date-timeOptional

Last modification date of the user

lastnamestringRequired

The last name of the user

Example: Doe

localestring · enumOptional

Example: de_DEPossible values:

usernamestringRequired

The username of the user

Example: johndoe

versionnumberRequired

Version of the user

Example: 1

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this

application/json

404

The requested entity was not found

application/json

patch

/api/users/{userId}

PATCH /api/users/{userId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 241

{
  "actions": [
    {
      "action": "ModifyUser",
      "assignedRoles": [
        {
          "context": [
            {
              "type": "FACILITY",
              "values": [
                "text"
              ]
            }
          ],
          "ref": "text"
        }
      ],
      "customAttributes": {},
      "email": "text",
      "firstname": "text",
      "lastname": "text",
      "locale": "de_DE",
      "password": "text"
    }
  ],
  "version": 1
}

{
  "assignedRoles": [
    {
      "context": [
        {
          "type": "FACILITY",
          "values": [
            "text"
          ]
        }
      ],
      "ref": "text"
    }
  ],
  "authenticationProvider": {
    "id": "text",
    "type": "EMAIL_PASSWORD"
  },
  "authenticationProviderType": "de_DE",
  "created": "2026-03-13T15:49:20.185Z",
  "email": "[email protected]",
  "facilityLimitations": [
    "text"
  ],
  "firstname": "John",
  "id": "text",
  "lastLogin": "2026-03-13T15:49:20.185Z",
  "lastModified": "2026-03-13T15:49:20.185Z",
  "lastname": "Doe",
  "locale": "de_DE",
  "username": "johndoe",
  "version": 1
}

Create facility assignment

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

userIdstringRequired

Body

UserAssignedFacilityForCreation

facilityRefstringRequired

The id of the assigned facility

Responses

200

The facilities were successfully assigned to the user.

No content

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this

application/json

404

The requested entity was not found

application/json

post

/api/users/{userId}/assignedFacilities

POST /api/users/{userId}/assignedFacilities HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 59

{
  "assignedZones": [
    {
      "zoneRef": "text"
    }
  ],
  "facilityRef": "text"
}

No content

Get user roles

get

Returns the roles of a user.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

userIdstringRequired

Responses

200

The roles of the user.

No content

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this

application/json

404

The requested entity was not found

application/json

get

/api/users/{userId}/permissions

GET /api/users/{userId}/permissions HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Deprecated

Update me user

patch

This part of the API is deprecated. For details please check the api-release-life-cycle documentation. Update my own data.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

ModifyUserPersonalData

firstnamestringOptional

The new firstname of the user

lastnamestringOptional

The new lastname of the user

localestring · enumOptional

Example: de_DEPossible values:

Responses

200

Updating my data was successful.

application/json

User

authenticationProviderTypestring · enumOptional

Example: de_DEPossible values:

createdstring · date-timeOptional

Creation date of the user

emailstringOptional

The email of the user

Example: [email protected]

facilityLimitationsstring[]Optional

Facilities where at least one role of the user has access to. Not present if the user has at least one role which is unrestricted

firstnamestringRequired

The first name of the user

Example: John

idstringRequired

The id of the user

lastLoginstring · date-timeOptional

The last login timestamp of the user

lastModifiedstring · date-timeOptional

Last modification date of the user

lastnamestringRequired

The last name of the user

Example: Doe

localestring · enumOptional

Example: de_DEPossible values:

usernamestringRequired

The username of the user

Example: johndoe

versionnumberRequired

Version of the user

Example: 1

401

Your user is not allowed to operate against this API instance

application/json

patch

/api/users/me

PATCH /api/users/me HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "firstname": "text",
  "lastname": "text",
  "locale": "de_DE"
}

{
  "assignedRoles": [
    {
      "context": [
        {
          "type": "FACILITY",
          "values": [
            "text"
          ]
        }
      ],
      "ref": "text"
    }
  ],
  "authenticationProvider": {
    "id": "text",
    "type": "EMAIL_PASSWORD"
  },
  "authenticationProviderType": "de_DE",
  "created": "2026-03-13T15:49:20.185Z",
  "email": "[email protected]",
  "facilityLimitations": [
    "text"
  ],
  "firstname": "John",
  "id": "text",
  "lastLogin": "2026-03-13T15:49:20.185Z",
  "lastModified": "2026-03-13T15:49:20.185Z",
  "lastname": "Doe",
  "locale": "de_DE",
  "username": "johndoe",
  "version": 1
}

Call user action

post

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation. Executes an action to manipulate my user.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

User action was successfully executed.

application/json

User

authenticationProviderTypestring · enumOptional

Example: de_DEPossible values:

createdstring · date-timeOptional

Creation date of the user

emailstringOptional

The email of the user

Example: [email protected]

facilityLimitationsstring[]Optional

Facilities where at least one role of the user has access to. Not present if the user has at least one role which is unrestricted

firstnamestringRequired

The first name of the user

Example: John

idstringRequired

The id of the user

lastLoginstring · date-timeOptional

The last login timestamp of the user

lastModifiedstring · date-timeOptional

Last modification date of the user

lastnamestringRequired

The last name of the user

Example: Doe

localestring · enumOptional

Example: de_DEPossible values:

usernamestringRequired

The username of the user

Example: johndoe

versionnumberRequired

Version of the user

Example: 1

400

Invalid input. See response for details.

application/json

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this

application/json

409

A version conflict occurred.

application/json

post

/api/users/me/actions

POST /api/users/me/actions HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "assignedRoles": [
    {
      "context": [
        {
          "type": "FACILITY",
          "values": [
            "text"
          ]
        }
      ],
      "ref": "text"
    }
  ],
  "authenticationProvider": {
    "id": "text",
    "type": "EMAIL_PASSWORD"
  },
  "authenticationProviderType": "de_DE",
  "created": "2026-03-13T15:49:20.185Z",
  "email": "[email protected]",
  "facilityLimitations": [
    "text"
  ],
  "firstname": "John",
  "id": "text",
  "lastLogin": "2026-03-13T15:49:20.185Z",
  "lastModified": "2026-03-13T15:49:20.185Z",
  "lastname": "Doe",
  "locale": "de_DE",
  "username": "johndoe",
  "version": 1
}

Return effective permissions

get

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation. Returns the effective permissions of the user.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

The effective permissions of the user.

application/json

EffectivePermissionsResponse

userIdstringRequired

User ID of the current user

401

Your user is not allowed to operate against this API instance

application/json

get

/api/users/me/effectivepermissions

GET /api/users/me/effectivepermissions HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "roles": [
    {
      "context": [
        {
          "type": "FACILITY",
          "values": [
            "text"
          ]
        }
      ],
      "facilities": [
        "text"
      ],
      "name": "text"
    }
  ],
  "userId": "text"
}

List users (search)

post

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation. Search for User

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

UserSearchPayload

afterstringOptional

The cursor to start after for forward pagination. The value is provided in the pageInfo.endCursor field of the response. Cannot be used with before or last.

beforestringOptional

The cursor to start before for backward pagination. The value is provided in the pageInfo.startCursor field of the response. Cannot be used with after or size (first).

lastnumber · min: 1 · max: 250Optional

Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.

sizenumber · min: 1 · max: 250Optional

Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.

startAfterIdstringOptionalDeprecated

The ID to start after. Deprecated, use after with the value provided in pageInfo.endCursor instead.

Responses

200

Your search result

application/json

UserPaginatedResult

totalnumberOptional

The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this

application/json

post

/api/users/search

POST /api/users/search HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 6644

{
  "after": "text",
  "before": "text",
  "last": 1,
  "options": {
    "withTotal": true
  },
  "query": {
    "and": [
      {
        "and": [
          {
            "and": "[Circular Reference]",
            "assignedFacilities": {
              "contains": {
                "facilityRef": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              }
            },
            "assignedRoles": {
              "contains": {
                "context": {
                  "contains": {
                    "type": {
                      "eq": "FACILITY",
                      "in": [
                        "FACILITY"
                      ],
                      "notEq": "FACILITY"
                    },
                    "values": {
                      "contains": {
                        "eq": "text",
                        "notEq": "text"
                      }
                    }
                  }
                },
                "ref": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              }
            },
            "auth": {
              "type": {
                "eq": "EMAIL_PASSWORD",
                "in": [
                  "EMAIL_PASSWORD"
                ],
                "notEq": "EMAIL_PASSWORD"
              }
            },
            "customAttributes": {
              "ANY_ADDITIONAL_PROPERTY": {
                "eq": true,
                "notEq": true
              }
            },
            "customClaims": {
              "roles": {
                "contains": {
                  "facilities": {
                    "contains": {
                      "eq": "text",
                      "notEq": "text"
                    }
                  },
                  "name": {
                    "eq": "FULFILLER",
                    "in": [
                      "FULFILLER"
                    ],
                    "notEq": "FULFILLER"
                  }
                }
              }
            },
            "facilityLimitations": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              },
              "exists": true
            },
            "firstname": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "lastModified": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-13T15:49:20.185Z",
              "gt": "2026-03-13T15:49:20.185Z",
              "gte": "2026-03-13T15:49:20.185Z",
              "lt": "2026-03-13T15:49:20.185Z",
              "lte": "2026-03-13T15:49:20.185Z",
              "notEq": "2026-03-13T15:49:20.185Z"
            },
            "lastname": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "or": "[Circular Reference]",
            "username": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        ],
        "assignedFacilities": {
          "contains": {
            "facilityRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        },
        "assignedRoles": {
          "contains": {
            "context": {
              "contains": {
                "type": {
                  "eq": "FACILITY",
                  "in": [
                    "FACILITY"
                  ],
                  "notEq": "FACILITY"
                },
                "values": {
                  "contains": {
                    "eq": "text",
                    "notEq": "text"
                  }
                }
              }
            },
            "ref": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        },
        "auth": {
          "type": {
            "eq": "EMAIL_PASSWORD",
            "in": [
              "EMAIL_PASSWORD"
            ],
            "notEq": "EMAIL_PASSWORD"
          }
        },
        "customAttributes": {
          "ANY_ADDITIONAL_PROPERTY": {
            "eq": true,
            "notEq": true
          }
        },
        "customClaims": {
          "roles": {
            "contains": {
              "facilities": {
                "contains": {
                  "eq": "text",
                  "notEq": "text"
                }
              },
              "name": {
                "eq": "FULFILLER",
                "in": [
                  "FULFILLER"
                ],
                "notEq": "FULFILLER"
              }
            }
          }
        },
        "facilityLimitations": {
          "contains": {
            "eq": "text",
            "notEq": "text"
          },
          "exists": true
        },
        "firstname": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "lastModified": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-13T15:49:20.185Z",
          "gt": "2026-03-13T15:49:20.185Z",
          "gte": "2026-03-13T15:49:20.185Z",
          "lt": "2026-03-13T15:49:20.185Z",
          "lte": "2026-03-13T15:49:20.185Z",
          "notEq": "2026-03-13T15:49:20.185Z"
        },
        "lastname": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "or": [
          {
            "and": "[Circular Reference]",
            "assignedFacilities": {
              "contains": {
                "facilityRef": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              }
            },
            "assignedRoles": {
              "contains": {
                "context": {
                  "contains": {
                    "type": {
                      "eq": "FACILITY",
                      "in": [
                        "FACILITY"
                      ],
                      "notEq": "FACILITY"
                    },
                    "values": {
                      "contains": {
                        "eq": "text",
                        "notEq": "text"
                      }
                    }
                  }
                },
                "ref": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              }
            },
            "auth": {
              "type": {
                "eq": "EMAIL_PASSWORD",
                "in": [
                  "EMAIL_PASSWORD"
                ],
                "notEq": "EMAIL_PASSWORD"
              }
            },
            "customAttributes": {
              "ANY_ADDITIONAL_PROPERTY": {
                "eq": true,
                "notEq": true
              }
            },
            "customClaims": {
              "roles": {
                "contains": {
                  "facilities": {
                    "contains": {
                      "eq": "text",
                      "notEq": "text"
                    }
                  },
                  "name": {
                    "eq": "FULFILLER",
                    "in": [
                      "FULFILLER"
                    ],
                    "notEq": "FULFILLER"
                  }
                }
              }
            },
            "facilityLimitations": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              },
              "exists": true
            },
            "firstname": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "lastModified": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-13T15:49:20.185Z",
              "gt": "2026-03-13T15:49:20.185Z",
              "gte": "2026-03-13T15:49:20.185Z",
              "lt": "2026-03-13T15:49:20.185Z",
              "lte": "2026-03-13T15:49:20.185Z",
              "notEq": "2026-03-13T15:49:20.185Z"
            },
            "lastname": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "or": "[Circular Reference]",
            "username": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        ],
        "username": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        }
      }
    ],
    "assignedFacilities": {
      "contains": {
        "facilityRef": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        }
      }
    },
    "assignedRoles": {
      "contains": {
        "context": {
          "contains": {
            "type": {
              "eq": "FACILITY",
              "in": [
                "FACILITY"
              ],
              "notEq": "FACILITY"
            },
            "values": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            }
          }
        },
        "ref": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        }
      }
    },
    "auth": {
      "type": {
        "eq": "EMAIL_PASSWORD",
        "in": [
          "EMAIL_PASSWORD"
        ],
        "notEq": "EMAIL_PASSWORD"
      }
    },
    "customAttributes": {
      "ANY_ADDITIONAL_PROPERTY": {
        "eq": true,
        "notEq": true
      }
    },
    "customClaims": {
      "roles": {
        "contains": {
          "facilities": {
            "contains": {
              "eq": "text",
              "notEq": "text"
            }
          },
          "name": {
            "eq": "FULFILLER",
            "in": [
              "FULFILLER"
            ],
            "notEq": "FULFILLER"
          }
        }
      }
    },
    "facilityLimitations": {
      "contains": {
        "eq": "text",
        "notEq": "text"
      },
      "exists": true
    },
    "firstname": {
      "eq": "text",
      "in": [
        "text"
      ],
      "like": "text",
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "lastModified": {
      "after": "text",
      "before": "text",
      "eq": "2026-03-13T15:49:20.185Z",
      "gt": "2026-03-13T15:49:20.185Z",
      "gte": "2026-03-13T15:49:20.185Z",
      "lt": "2026-03-13T15:49:20.185Z",
      "lte": "2026-03-13T15:49:20.185Z",
      "notEq": "2026-03-13T15:49:20.185Z"
    },
    "lastname": {
      "eq": "text",
      "in": [
        "text"
      ],
      "like": "text",
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "or": [
      {
        "and": "[Circular Reference]",
        "assignedFacilities": {
          "contains": {
            "facilityRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        },
        "assignedRoles": {
          "contains": {
            "context": {
              "contains": {
                "type": {
                  "eq": "FACILITY",
                  "in": [
                    "FACILITY"
                  ],
                  "notEq": "FACILITY"
                },
                "values": {
                  "contains": {
                    "eq": "text",
                    "notEq": "text"
                  }
                }
              }
            },
            "ref": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        },
        "auth": {
          "type": {
            "eq": "EMAIL_PASSWORD",
            "in": [
              "EMAIL_PASSWORD"
            ],
            "notEq": "EMAIL_PASSWORD"
          }
        },
        "customAttributes": {
          "ANY_ADDITIONAL_PROPERTY": {
            "eq": true,
            "notEq": true
          }
        },
        "customClaims": {
          "roles": {
            "contains": {
              "facilities": {
                "contains": {
                  "eq": "text",
                  "notEq": "text"
                }
              },
              "name": {
                "eq": "FULFILLER",
                "in": [
                  "FULFILLER"
                ],
                "notEq": "FULFILLER"
              }
            }
          }
        },
        "facilityLimitations": {
          "contains": {
            "eq": "text",
            "notEq": "text"
          },
          "exists": true
        },
        "firstname": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "lastModified": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-13T15:49:20.185Z",
          "gt": "2026-03-13T15:49:20.185Z",
          "gte": "2026-03-13T15:49:20.185Z",
          "lt": "2026-03-13T15:49:20.185Z",
          "lte": "2026-03-13T15:49:20.185Z",
          "notEq": "2026-03-13T15:49:20.185Z"
        },
        "lastname": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "or": "[Circular Reference]",
        "username": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        }
      }
    ],
    "username": {
      "eq": "text",
      "in": [
        "text"
      ],
      "like": "text",
      "notEq": "text",
      "notIn": [
        "text"
      ]
    }
  },
  "size": 1,
  "sort": [
    {
      "customAttributes": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "firstname": "ASC",
      "lastname": "ASC",
      "username": "ASC"
    }
  ]
}

{
  "pageInfo": {
    "endCursor": "text",
    "hasNextPage": true,
    "hasPreviousPage": true,
    "startCursor": "text"
  },
  "total": 1,
  "users": [
    {
      "assignedRoles": [
        {
          "context": [
            {
              "type": "FACILITY",
              "values": [
                "text"
              ]
            }
          ],
          "ref": "text"
        }
      ],
      "authenticationProvider": {
        "id": "text",
        "type": "EMAIL_PASSWORD"
      },
      "authenticationProviderType": "de_DE",
      "created": "2026-03-13T15:49:20.185Z",
      "email": "[email protected]",
      "facilityLimitations": [
        "text"
      ],
      "firstname": "John",
      "id": "text",
      "lastLogin": "2026-03-13T15:49:20.185Z",
      "lastModified": "2026-03-13T15:49:20.185Z",
      "lastname": "Doe",
      "locale": "de_DE",
      "username": "johndoe",
      "version": 1
    }
  ]
}

Last updated 2 hours ago

hashtagList permissions

hashtagList roles

hashtagCreate role

hashtagReturn role

hashtagUpdate role

hashtagDelete role

hashtagUpdate role

hashtagList roles (search)

hashtagList users

hashtagCreates user

hashtagReturn user

hashtagDelete user

hashtagUpdate user

hashtagCreate facility assignment

hashtagGet user roles

hashtagUpdate me user

hashtagCall user action

hashtagReturn effective permissions

hashtagList users (search)

List permissions

List roles

Create role

Return role

Update role

Delete role

Update role

List roles (search)

List users

Creates user

Return user

Delete user

Update user

Create facility assignment

Get user roles

Update me user

Call user action

Return effective permissions

List users (search)