User endpoints

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

This part of the API is in Beta status. For details, see the API release lifecycle 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

customAttributesobject · nullableOptional

The custom attributes of the user

emailstringOptional

The email of the user

Example: [e-mail]

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

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f

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

This part of the API is in Beta status. For details, see the API release lifecycle documentation.

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

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 endpoint

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": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
    "type": "EMAIL_PASSWORD"
  },
  "authenticationProviderType": "de_DE",
  "created": "2026-01-01T00:00:00.000Z",
  "customAttributes": {},
  "email": "[e-mail]",
  "facilityLimitations": [
    "text"
  ],
  "firstname": "John",
  "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
  "lastLogin": "2026-01-01T00:00:00.000Z",
  "lastModified": "2026-01-01T00:00:00.000Z",
  "lastname": "Doe",
  "locale": "de_DE",
  "username": "johndoe",
  "version": 1
}

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 endpoint

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

List users

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

sizenumber · min: 1 · max: 100OptionalDefault: 25Example: 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, see the API release lifecycle 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

customAttributesobject · nullableOptional

The custom attributes of the user

emailstringOptional

The email of the user

Example: [e-mail]

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

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f

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

This part of the API is in Beta status. For details, see the API release lifecycle documentation.

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

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 endpoint

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": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
    "type": "EMAIL_PASSWORD"
  },
  "authenticationProviderType": "de_DE",
  "created": "2026-01-01T00:00:00.000Z",
  "customAttributes": {},
  "email": "[e-mail]",
  "facilityLimitations": [
    "text"
  ],
  "firstname": "John",
  "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
  "lastLogin": "2026-01-01T00:00:00.000Z",
  "lastModified": "2026-01-01T00:00:00.000Z",
  "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 endpoint

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

Example: 1

Responses

200

The modified user.

application/json

User

authenticationProviderTypestring · enumOptional

This part of the API is in Beta status. For details, see the API release lifecycle 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

customAttributesobject · nullableOptional

The custom attributes of the user

emailstringOptional

The email of the user

Example: [e-mail]

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

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f

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

This part of the API is in Beta status. For details, see the API release lifecycle documentation.

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

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 endpoint

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: 269

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

{
  "assignedRoles": [
    {
      "context": [
        {
          "type": "FACILITY",
          "values": [
            "text"
          ]
        }
      ],
      "ref": "text"
    }
  ],
  "authenticationProvider": {
    "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
    "type": "EMAIL_PASSWORD"
  },
  "authenticationProviderType": "de_DE",
  "created": "2026-01-01T00:00:00.000Z",
  "customAttributes": {},
  "email": "[e-mail]",
  "facilityLimitations": [
    "text"
  ],
  "firstname": "John",
  "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
  "lastLogin": "2026-01-01T00:00:00.000Z",
  "lastModified": "2026-01-01T00:00:00.000Z",
  "lastname": "Doe",
  "locale": "de_DE",
  "username": "johndoe",
  "version": 1
}

Creates user

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

UserForCreation

customAttributesobject · nullableOptional

The custom attributes of the user

emailstringOptional

The email of the user

Example: [e-mail]

firstnamestringRequired

The first name of the user

Example: John

lastnamestringRequired

The last name of the user

Example: Doe

localestring · enumOptional

This part of the API is in Beta status. For details, see the API release lifecycle documentation.

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

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

User

authenticationProviderTypestring · enumOptional

This part of the API is in Beta status. For details, see the API release lifecycle 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

customAttributesobject · nullableOptional

The custom attributes of the user

emailstringOptional

The email of the user

Example: [e-mail]

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

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f

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

This part of the API is in Beta status. For details, see the API release lifecycle documentation.

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

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 endpoint

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: 393

{
  "assignedFacilities": [
    {
      "assignedZones": [
        {
          "zoneRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
        }
      ],
      "facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
    }
  ],
  "assignedRoles": [
    {
      "context": [
        {
          "type": "FACILITY",
          "values": [
            "text"
          ]
        }
      ],
      "ref": "text"
    }
  ],
  "customAttributes": {},
  "email": "[e-mail]",
  "firstname": "John",
  "lastname": "Doe",
  "locale": "de_DE",
  "password": "elephantMangoDance123",
  "username": "johndoe"
}

{
  "assignedRoles": [
    {
      "context": [
        {
          "type": "FACILITY",
          "values": [
            "text"
          ]
        }
      ],
      "ref": "text"
    }
  ],
  "authenticationProvider": {
    "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
    "type": "EMAIL_PASSWORD"
  },
  "authenticationProviderType": "de_DE",
  "created": "2026-01-01T00:00:00.000Z",
  "customAttributes": {},
  "email": "[e-mail]",
  "facilityLimitations": [
    "text"
  ],
  "firstname": "John",
  "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
  "lastLogin": "2026-01-01T00:00:00.000Z",
  "lastModified": "2026-01-01T00:00:00.000Z",
  "lastname": "Doe",
  "locale": "de_DE",
  "username": "johndoe",
  "version": 1
}

List users (search)

post

This part of the API is in Beta status. For details, see the API release lifecycle 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.

Example: 10

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 endpoint

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: 6243

{
  "after": "text",
  "before": "text",
  "last": 1,
  "options": {
    "withTotal": true
  },
  "query": {
    "and": [
      {
        "and": [
          {
            "and": "[Circular Reference]",
            "assignedFacilities": {
              "contains": {
                "facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
              },
              "exists": true
            },
            "assignedRoles": {
              "contains": {
                "context": {
                  "contains": {
                    "type": {
                      "eq": "FACILITY",
                      "in": [
                        "FACILITY"
                      ],
                      "notEq": "FACILITY"
                    },
                    "values": {
                      "contains": {
                        "eq": "text",
                        "notEq": "text"
                      }
                    }
                  },
                  "exists": true
                },
                "ref": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              },
              "exists": true
            },
            "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"
                  }
                },
                "exists": true
              }
            },
            "facilityLimitations": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              },
              "exists": true
            },
            "firstname": "Phil",
            "lastModified": {
              "after": "text",
              "before": "text",
              "eq": "2026-01-01T00:00:00.000Z",
              "gt": "2026-01-01T00:00:00.000Z",
              "gte": "2026-01-01T00:00:00.000Z",
              "lt": "2026-01-01T00:00:00.000Z",
              "lte": "2026-01-01T00:00:00.000Z",
              "notEq": "2026-01-01T00:00:00.000Z"
            },
            "lastname": "Bison",
            "or": "[Circular Reference]",
            "username": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        ],
        "assignedFacilities": {
          "contains": {
            "facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
          },
          "exists": true
        },
        "assignedRoles": {
          "contains": {
            "context": {
              "contains": {
                "type": {
                  "eq": "FACILITY",
                  "in": [
                    "FACILITY"
                  ],
                  "notEq": "FACILITY"
                },
                "values": {
                  "contains": {
                    "eq": "text",
                    "notEq": "text"
                  }
                }
              },
              "exists": true
            },
            "ref": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          },
          "exists": true
        },
        "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"
              }
            },
            "exists": true
          }
        },
        "facilityLimitations": {
          "contains": {
            "eq": "text",
            "notEq": "text"
          },
          "exists": true
        },
        "firstname": "Phil",
        "lastModified": {
          "after": "text",
          "before": "text",
          "eq": "2026-01-01T00:00:00.000Z",
          "gt": "2026-01-01T00:00:00.000Z",
          "gte": "2026-01-01T00:00:00.000Z",
          "lt": "2026-01-01T00:00:00.000Z",
          "lte": "2026-01-01T00:00:00.000Z",
          "notEq": "2026-01-01T00:00:00.000Z"
        },
        "lastname": "Bison",
        "or": [
          {
            "and": "[Circular Reference]",
            "assignedFacilities": {
              "contains": {
                "facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
              },
              "exists": true
            },
            "assignedRoles": {
              "contains": {
                "context": {
                  "contains": {
                    "type": {
                      "eq": "FACILITY",
                      "in": [
                        "FACILITY"
                      ],
                      "notEq": "FACILITY"
                    },
                    "values": {
                      "contains": {
                        "eq": "text",
                        "notEq": "text"
                      }
                    }
                  },
                  "exists": true
                },
                "ref": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              },
              "exists": true
            },
            "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"
                  }
                },
                "exists": true
              }
            },
            "facilityLimitations": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              },
              "exists": true
            },
            "firstname": "Phil",
            "lastModified": {
              "after": "text",
              "before": "text",
              "eq": "2026-01-01T00:00:00.000Z",
              "gt": "2026-01-01T00:00:00.000Z",
              "gte": "2026-01-01T00:00:00.000Z",
              "lt": "2026-01-01T00:00:00.000Z",
              "lte": "2026-01-01T00:00:00.000Z",
              "notEq": "2026-01-01T00:00:00.000Z"
            },
            "lastname": "Bison",
            "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": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
      },
      "exists": true
    },
    "assignedRoles": {
      "contains": {
        "context": {
          "contains": {
            "type": {
              "eq": "FACILITY",
              "in": [
                "FACILITY"
              ],
              "notEq": "FACILITY"
            },
            "values": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            }
          },
          "exists": true
        },
        "ref": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        }
      },
      "exists": true
    },
    "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"
          }
        },
        "exists": true
      }
    },
    "facilityLimitations": {
      "contains": {
        "eq": "text",
        "notEq": "text"
      },
      "exists": true
    },
    "firstname": "Phil",
    "lastModified": {
      "after": "text",
      "before": "text",
      "eq": "2026-01-01T00:00:00.000Z",
      "gt": "2026-01-01T00:00:00.000Z",
      "gte": "2026-01-01T00:00:00.000Z",
      "lt": "2026-01-01T00:00:00.000Z",
      "lte": "2026-01-01T00:00:00.000Z",
      "notEq": "2026-01-01T00:00:00.000Z"
    },
    "lastname": "Bison",
    "or": [
      {
        "and": "[Circular Reference]",
        "assignedFacilities": {
          "contains": {
            "facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
          },
          "exists": true
        },
        "assignedRoles": {
          "contains": {
            "context": {
              "contains": {
                "type": {
                  "eq": "FACILITY",
                  "in": [
                    "FACILITY"
                  ],
                  "notEq": "FACILITY"
                },
                "values": {
                  "contains": {
                    "eq": "text",
                    "notEq": "text"
                  }
                }
              },
              "exists": true
            },
            "ref": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          },
          "exists": true
        },
        "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"
              }
            },
            "exists": true
          }
        },
        "facilityLimitations": {
          "contains": {
            "eq": "text",
            "notEq": "text"
          },
          "exists": true
        },
        "firstname": "Phil",
        "lastModified": {
          "after": "text",
          "before": "text",
          "eq": "2026-01-01T00:00:00.000Z",
          "gt": "2026-01-01T00:00:00.000Z",
          "gte": "2026-01-01T00:00:00.000Z",
          "lt": "2026-01-01T00:00:00.000Z",
          "lte": "2026-01-01T00:00:00.000Z",
          "notEq": "2026-01-01T00:00:00.000Z"
        },
        "lastname": "Bison",
        "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": 10,
  "sort": [
    {
      "assignedRoles": {
        "ref": "ASC"
      },
      "authenticationProvider": {
        "type": "ASC"
      },
      "customAttributes": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "firstname": "ASC",
      "lastLogin": "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": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
        "type": "EMAIL_PASSWORD"
      },
      "authenticationProviderType": "de_DE",
      "created": "2026-01-01T00:00:00.000Z",
      "customAttributes": {},
      "email": "[e-mail]",
      "facilityLimitations": [
        "text"
      ],
      "firstname": "John",
      "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
      "lastLogin": "2026-01-01T00:00:00.000Z",
      "lastModified": "2026-01-01T00:00:00.000Z",
      "lastname": "Doe",
      "locale": "de_DE",
      "username": "johndoe",
      "version": 1
    }
  ]
}

Call user action

post

Executes an action to manipulate my user.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

or

Responses

200

User action was successfully executed.

application/json

User

authenticationProviderTypestring · enumOptional

This part of the API is in Beta status. For details, see the API release lifecycle 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

customAttributesobject · nullableOptional

The custom attributes of the user

emailstringOptional

The email of the user

Example: [e-mail]

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

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f

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

This part of the API is in Beta status. For details, see the API release lifecycle documentation.

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

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 endpoint

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
Content-Type: application/json
Accept: */*
Content-Length: 76

{
  "action": "ModifyMe",
  "firstname": "Phil",
  "lastname": "Bison",
  "locale": "de_DE"
}

{
  "assignedRoles": [
    {
      "context": [
        {
          "type": "FACILITY",
          "values": [
            "text"
          ]
        }
      ],
      "ref": "text"
    }
  ],
  "authenticationProvider": {
    "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
    "type": "EMAIL_PASSWORD"
  },
  "authenticationProviderType": "de_DE",
  "created": "2026-01-01T00:00:00.000Z",
  "customAttributes": {},
  "email": "[e-mail]",
  "facilityLimitations": [
    "text"
  ],
  "firstname": "John",
  "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
  "lastLogin": "2026-01-01T00:00:00.000Z",
  "lastModified": "2026-01-01T00:00:00.000Z",
  "lastname": "Doe",
  "locale": "de_DE",
  "username": "johndoe",
  "version": 1
}

Deprecated

Update me user

patch

This part of the API is deprecated. For details, see the API release lifecycle documentation. Update my own data.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

ModifyUserPersonalData

firstnamestringOptional

The new firstname of the user

Example: Phil

lastnamestringOptional

The new lastname of the user

Example: Bison

localestring · enumOptional

This part of the API is in Beta status. For details, see the API release lifecycle documentation.

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

Example: de_DEPossible values:

Responses

200

Updating my data was successful.

application/json

User

authenticationProviderTypestring · enumOptional

This part of the API is in Beta status. For details, see the API release lifecycle 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

customAttributesobject · nullableOptional

The custom attributes of the user

emailstringOptional

The email of the user

Example: [e-mail]

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

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f

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

This part of the API is in Beta status. For details, see the API release lifecycle documentation.

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

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: 56

{
  "firstname": "Phil",
  "lastname": "Bison",
  "locale": "de_DE"
}

{
  "assignedRoles": [
    {
      "context": [
        {
          "type": "FACILITY",
          "values": [
            "text"
          ]
        }
      ],
      "ref": "text"
    }
  ],
  "authenticationProvider": {
    "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
    "type": "EMAIL_PASSWORD"
  },
  "authenticationProviderType": "de_DE",
  "created": "2026-01-01T00:00:00.000Z",
  "customAttributes": {},
  "email": "[e-mail]",
  "facilityLimitations": [
    "text"
  ],
  "firstname": "John",
  "id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
  "lastLogin": "2026-01-01T00:00:00.000Z",
  "lastModified": "2026-01-01T00:00:00.000Z",
  "lastname": "Doe",
  "locale": "de_DE",
  "username": "johndoe",
  "version": 1
}

Return effective permissions

get

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"
          ]
        }
      ],
      "name": "text",
      "permissions": [
        "USER_READ"
      ]
    }
  ],
  "userId": "text"
}