Remote configuration endpoints

Deprecated

List remote configs

get

This part of the API is deprecated. For details, see the API release lifecycle documentation. Deprecated: Use /api/remoteconfigurations/search instead

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

sizenumber · max: 500Optional

Number of results to return (max 500)

Default: 25Example: 25

startAfterIdstringOptional

Cursor for pagination - ID to start after

groupsstring[]Optional

Filter by group(s)

facilityIdstringOptional

Filter by facility ID

userIdstringOptional

Filter by user ID

Responses

200

Central RemoteConfiguration

application/json

RemoteConfigurations

totalnumberOptional

Total number of found entities for this query

Example: 42

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/remoteconfigs

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

{
  "remoteConfigurations": [
    {
      "created": "2026-01-01T00:00:00.000Z",
      "flattenScopeIds": [
        "INVENTORY",
        "67151fc3-3ce1-400e-8b23-23c29e0cde90"
      ],
      "groups": [
        "INVENTORY"
      ],
      "id": "LGMl2DuvPnfPoSHhYFOm",
      "key": "PICKING_SHOW_NEW_SCAN_VIEW",
      "lastModified": "2026-01-01T00:00:00.000Z",
      "scopes": [
        {
          "facilityRefs": [
            "928f3730-bc48-4d85-b83f-3fd86b776178"
          ],
          "id": "LGMl2DuvPnfPoSHhYFOm",
          "userRefs": [
            "928f3730-bc48-4d85-b83f-3fd86b776178"
          ]
        }
      ],
      "value": "text",
      "valueType": "BOOLEAN",
      "version": 1
    }
  ],
  "total": 42
}

Create remote config

post

Create a new remote configuration with specified key, value, type, groups, and optional scopes.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

RemoteConfigurationForCreation

groupsstring[] · min: 1 · max: 20Required

Groups this configuration belongs to

Example: ["INVENTORY"]

keystringRequired

Unique business key of this entity

Example: PICKING_SHOW_NEW_SCAN_VIEW

valueone ofRequired

The value of this remote configuration

stringOptional

or

integerOptional

or

numberOptional

or

booleanOptional

or

objectOptional

valueTypestring · enumRequired

The type of the value

Possible values:

Responses

200

Created entity in the body.

application/json

RemoteConfiguration

createdstring · date-timeOptional

The date this entity was created at the platform

flattenScopeIdsstring[]Required

Generated flatten unique ids of all scope sub elements (userRef, facilityRef)

Example: ["INVENTORY","67151fc3-3ce1-400e-8b23-23c29e0cde90"]

groupsstring[] · min: 1 · max: 20Required

Groups this configuration belongs to

Example: ["INVENTORY"]

idstringRequired

Auto generated unique identifier

Example: LGMl2DuvPnfPoSHhYFOm

keystringRequired

Unique business key of this entity

Example: PICKING_SHOW_NEW_SCAN_VIEW

lastModifiedstring · date-timeOptional

The date this entity was modified last

valueone ofRequired

The value of this remote configuration

stringOptional

or

integerOptional

or

numberOptional

or

booleanOptional

or

objectOptional

valueTypestring · enumRequired

The type of the value

Possible values:

versionnumberRequired

The version of the document for optimistic locking

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

post/api/remoteconfigs

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

{
  "groups": [
    "INVENTORY"
  ],
  "key": "PICKING_SHOW_NEW_SCAN_VIEW",
  "scopes": [
    {
      "facilityRefs": [
        "928f3730-bc48-4d85-b83f-3fd86b776178"
      ],
      "userRefs": [
        "928f3730-bc48-4d85-b83f-3fd86b776178"
      ]
    }
  ],
  "value": "text",
  "valueType": "BOOLEAN"
}

{
  "created": "2026-01-01T00:00:00.000Z",
  "flattenScopeIds": [
    "INVENTORY",
    "67151fc3-3ce1-400e-8b23-23c29e0cde90"
  ],
  "groups": [
    "INVENTORY"
  ],
  "id": "LGMl2DuvPnfPoSHhYFOm",
  "key": "PICKING_SHOW_NEW_SCAN_VIEW",
  "lastModified": "2026-01-01T00:00:00.000Z",
  "scopes": [
    {
      "facilityRefs": [
        "928f3730-bc48-4d85-b83f-3fd86b776178"
      ],
      "id": "LGMl2DuvPnfPoSHhYFOm",
      "userRefs": [
        "928f3730-bc48-4d85-b83f-3fd86b776178"
      ]
    }
  ],
  "value": "text",
  "valueType": "BOOLEAN",
  "version": 1
}

Get remote config

get

Get a single remote configuration by its unique identifier. Also accepts key in URN format (e.g. urn:fft:remoteconfig🔑{your-key}).

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Responses

200

Central RemoteConfiguration

application/json

RemoteConfiguration

createdstring · date-timeOptional

The date this entity was created at the platform

flattenScopeIdsstring[]Required

Generated flatten unique ids of all scope sub elements (userRef, facilityRef)

Example: ["INVENTORY","67151fc3-3ce1-400e-8b23-23c29e0cde90"]

groupsstring[] · min: 1 · max: 20Required

Groups this configuration belongs to

Example: ["INVENTORY"]

idstringRequired

Auto generated unique identifier

Example: LGMl2DuvPnfPoSHhYFOm

keystringRequired

Unique business key of this entity

Example: PICKING_SHOW_NEW_SCAN_VIEW

lastModifiedstring · date-timeOptional

The date this entity was modified last

valueone ofRequired

The value of this remote configuration

stringOptional

or

integerOptional

or

numberOptional

or

booleanOptional

or

objectOptional

valueTypestring · enumRequired

The type of the value

Possible values:

versionnumberRequired

The version of the document for optimistic locking

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/remoteconfigs/{id}

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

{
  "created": "2026-01-01T00:00:00.000Z",
  "flattenScopeIds": [
    "INVENTORY",
    "67151fc3-3ce1-400e-8b23-23c29e0cde90"
  ],
  "groups": [
    "INVENTORY"
  ],
  "id": "LGMl2DuvPnfPoSHhYFOm",
  "key": "PICKING_SHOW_NEW_SCAN_VIEW",
  "lastModified": "2026-01-01T00:00:00.000Z",
  "scopes": [
    {
      "facilityRefs": [
        "928f3730-bc48-4d85-b83f-3fd86b776178"
      ],
      "id": "LGMl2DuvPnfPoSHhYFOm",
      "userRefs": [
        "928f3730-bc48-4d85-b83f-3fd86b776178"
      ]
    }
  ],
  "value": "text",
  "valueType": "BOOLEAN",
  "version": 1
}

Update remote config

put

Replace an existing remote configuration by its unique identifier. All fields will be replaced with the provided values. Also accepts key in URN format (e.g. urn:fft:remoteconfig🔑{your-key}).

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Body

RemoteConfigurationForPut

groupsstring[] · min: 1 · max: 20Required

Groups this configuration belongs to

Example: ["INVENTORY"]

valueone ofRequired

The value of this remote configuration

stringOptional

or

integerOptional

or

numberOptional

or

booleanOptional

or

objectOptional

valueTypestring · enumRequired

The type of the value

Possible values:

versionnumberRequired

The version of the document for optimistic locking

Example: 1

Responses

200

Successfully Changed

application/json

RemoteConfiguration

createdstring · date-timeOptional

The date this entity was created at the platform

flattenScopeIdsstring[]Required

Generated flatten unique ids of all scope sub elements (userRef, facilityRef)

Example: ["INVENTORY","67151fc3-3ce1-400e-8b23-23c29e0cde90"]

groupsstring[] · min: 1 · max: 20Required

Groups this configuration belongs to

Example: ["INVENTORY"]

idstringRequired

Auto generated unique identifier

Example: LGMl2DuvPnfPoSHhYFOm

keystringRequired

Unique business key of this entity

Example: PICKING_SHOW_NEW_SCAN_VIEW

lastModifiedstring · date-timeOptional

The date this entity was modified last

valueone ofRequired

The value of this remote configuration

stringOptional

or

integerOptional

or

numberOptional

or

booleanOptional

or

objectOptional

valueTypestring · enumRequired

The type of the value

Possible values:

versionnumberRequired

The version of the document for optimistic locking

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

put/api/remoteconfigs/{id}

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

{
  "groups": [
    "INVENTORY"
  ],
  "scopes": [
    {
      "facilityRefs": [
        "928f3730-bc48-4d85-b83f-3fd86b776178"
      ],
      "userRefs": [
        "928f3730-bc48-4d85-b83f-3fd86b776178"
      ]
    }
  ],
  "value": "text",
  "valueType": "BOOLEAN",
  "version": 1
}

{
  "created": "2026-01-01T00:00:00.000Z",
  "flattenScopeIds": [
    "INVENTORY",
    "67151fc3-3ce1-400e-8b23-23c29e0cde90"
  ],
  "groups": [
    "INVENTORY"
  ],
  "id": "LGMl2DuvPnfPoSHhYFOm",
  "key": "PICKING_SHOW_NEW_SCAN_VIEW",
  "lastModified": "2026-01-01T00:00:00.000Z",
  "scopes": [
    {
      "facilityRefs": [
        "928f3730-bc48-4d85-b83f-3fd86b776178"
      ],
      "id": "LGMl2DuvPnfPoSHhYFOm",
      "userRefs": [
        "928f3730-bc48-4d85-b83f-3fd86b776178"
      ]
    }
  ],
  "value": "text",
  "valueType": "BOOLEAN",
  "version": 1
}

Create remote config scope

post

Add a new scope to an existing remote configuration. The scope will be added to the list of existing scopes. Also accepts key in URN format (e.g. urn:fft:remoteconfig🔑{your-key}).

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Body

AddRemoteConfigurationScopeParameter

remoteConfigVersionnumberRequired

The version of the remote config for optimistic locking

Example: 1

Responses

200

Updated RemoteConfiguration in the body.

application/json

RemoteConfiguration

createdstring · date-timeOptional

The date this entity was created at the platform

flattenScopeIdsstring[]Required

Generated flatten unique ids of all scope sub elements (userRef, facilityRef)

Example: ["INVENTORY","67151fc3-3ce1-400e-8b23-23c29e0cde90"]

groupsstring[] · min: 1 · max: 20Required

Groups this configuration belongs to

Example: ["INVENTORY"]

idstringRequired

Auto generated unique identifier

Example: LGMl2DuvPnfPoSHhYFOm

keystringRequired

Unique business key of this entity

Example: PICKING_SHOW_NEW_SCAN_VIEW

lastModifiedstring · date-timeOptional

The date this entity was modified last

valueone ofRequired

The value of this remote configuration

stringOptional

or

integerOptional

or

numberOptional

or

booleanOptional

or

objectOptional

valueTypestring · enumRequired

The type of the value

Possible values:

versionnumberRequired

The version of the document for optimistic locking

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

post/api/remoteconfigs/{id}/scopes

POST /api/remoteconfigs/{id}/scopes HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 143

{
  "remoteConfigVersion": 1,
  "scope": {
    "facilityRefs": [
      "928f3730-bc48-4d85-b83f-3fd86b776178"
    ],
    "userRefs": [
      "928f3730-bc48-4d85-b83f-3fd86b776178"
    ]
  }
}

{
  "created": "2026-01-01T00:00:00.000Z",
  "flattenScopeIds": [
    "INVENTORY",
    "67151fc3-3ce1-400e-8b23-23c29e0cde90"
  ],
  "groups": [
    "INVENTORY"
  ],
  "id": "LGMl2DuvPnfPoSHhYFOm",
  "key": "PICKING_SHOW_NEW_SCAN_VIEW",
  "lastModified": "2026-01-01T00:00:00.000Z",
  "scopes": [
    {
      "facilityRefs": [
        "928f3730-bc48-4d85-b83f-3fd86b776178"
      ],
      "id": "LGMl2DuvPnfPoSHhYFOm",
      "userRefs": [
        "928f3730-bc48-4d85-b83f-3fd86b776178"
      ]
    }
  ],
  "value": "text",
  "valueType": "BOOLEAN",
  "version": 1
}

Update remote config

patch

Update an existing remote configuration by its unique identifier. Only provided fields will be updated, others will remain unchanged. Also accepts key in URN format (e.g. urn:fft:remoteconfig🔑{your-key}).

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Body

RemoteConfigurationForUpdate

groupsstring[] · min: 1 · max: 20Optional

Groups this configuration belongs to

Example: ["INVENTORY"]

valueone ofOptional

The value of this remote configuration

stringOptional

or

integerOptional

or

numberOptional

or

booleanOptional

or

objectOptional

valueTypestring · enumOptional

The type of the value

Possible values:

versionnumberRequired

The version of the document for optimistic locking

Example: 1

Responses

200

Successfully Changed

application/json

RemoteConfiguration

createdstring · date-timeOptional

The date this entity was created at the platform

flattenScopeIdsstring[]Required

Generated flatten unique ids of all scope sub elements (userRef, facilityRef)

Example: ["INVENTORY","67151fc3-3ce1-400e-8b23-23c29e0cde90"]

groupsstring[] · min: 1 · max: 20Required

Groups this configuration belongs to

Example: ["INVENTORY"]

idstringRequired

Auto generated unique identifier

Example: LGMl2DuvPnfPoSHhYFOm

keystringRequired

Unique business key of this entity

Example: PICKING_SHOW_NEW_SCAN_VIEW

lastModifiedstring · date-timeOptional

The date this entity was modified last

valueone ofRequired

The value of this remote configuration

stringOptional

or

integerOptional

or

numberOptional

or

booleanOptional

or

objectOptional

valueTypestring · enumRequired

The type of the value

Possible values:

versionnumberRequired

The version of the document for optimistic locking

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/remoteconfigs/{id}

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

{
  "groups": [
    "INVENTORY"
  ],
  "scopes": [
    {
      "facilityRefs": [
        "928f3730-bc48-4d85-b83f-3fd86b776178"
      ],
      "userRefs": [
        "928f3730-bc48-4d85-b83f-3fd86b776178"
      ]
    }
  ],
  "value": "text",
  "valueType": "BOOLEAN",
  "version": 1
}

{
  "created": "2026-01-01T00:00:00.000Z",
  "flattenScopeIds": [
    "INVENTORY",
    "67151fc3-3ce1-400e-8b23-23c29e0cde90"
  ],
  "groups": [
    "INVENTORY"
  ],
  "id": "LGMl2DuvPnfPoSHhYFOm",
  "key": "PICKING_SHOW_NEW_SCAN_VIEW",
  "lastModified": "2026-01-01T00:00:00.000Z",
  "scopes": [
    {
      "facilityRefs": [
        "928f3730-bc48-4d85-b83f-3fd86b776178"
      ],
      "id": "LGMl2DuvPnfPoSHhYFOm",
      "userRefs": [
        "928f3730-bc48-4d85-b83f-3fd86b776178"
      ]
    }
  ],
  "value": "text",
  "valueType": "BOOLEAN",
  "version": 1
}

Delete remote config

delete

Delete a remote configuration by its unique identifier. This operation is irreversible. Also accepts key in URN format (e.g. urn:fft:remoteconfig🔑{your-key}).

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Responses

200

Successfully Deleted

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/remoteconfigs/{id}

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

No content

Delete remote config scope

delete

Remove a scope from an existing remote configuration by scope ID. The scope will be removed from the list of existing scopes. Also accepts key in URN format (e.g. urn:fft:remoteconfig🔑{your-key}).

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

scopeIdstringRequired

Query parameters

versionnumberRequired

Version of the remote config for optimistic locking

Responses

200

Successfully Deleted

application/json

RemoteConfiguration

createdstring · date-timeOptional

The date this entity was created at the platform

flattenScopeIdsstring[]Required

Generated flatten unique ids of all scope sub elements (userRef, facilityRef)

Example: ["INVENTORY","67151fc3-3ce1-400e-8b23-23c29e0cde90"]

groupsstring[] · min: 1 · max: 20Required

Groups this configuration belongs to

Example: ["INVENTORY"]

idstringRequired

Auto generated unique identifier

Example: LGMl2DuvPnfPoSHhYFOm

keystringRequired

Unique business key of this entity

Example: PICKING_SHOW_NEW_SCAN_VIEW

lastModifiedstring · date-timeOptional

The date this entity was modified last

valueone ofRequired

The value of this remote configuration

stringOptional

or

integerOptional

or

numberOptional

or

booleanOptional

or

objectOptional

valueTypestring · enumRequired

The type of the value

Possible values:

versionnumberRequired

The version of the document for optimistic locking

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

delete/api/remoteconfigs/{id}/scopes/{scopeId}

DELETE /api/remoteconfigs/{id}/scopes/{scopeId}?version=1 HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "created": "2026-01-01T00:00:00.000Z",
  "flattenScopeIds": [
    "INVENTORY",
    "67151fc3-3ce1-400e-8b23-23c29e0cde90"
  ],
  "groups": [
    "INVENTORY"
  ],
  "id": "LGMl2DuvPnfPoSHhYFOm",
  "key": "PICKING_SHOW_NEW_SCAN_VIEW",
  "lastModified": "2026-01-01T00:00:00.000Z",
  "scopes": [
    {
      "facilityRefs": [
        "928f3730-bc48-4d85-b83f-3fd86b776178"
      ],
      "id": "LGMl2DuvPnfPoSHhYFOm",
      "userRefs": [
        "928f3730-bc48-4d85-b83f-3fd86b776178"
      ]
    }
  ],
  "value": "text",
  "valueType": "BOOLEAN",
  "version": 1
}