Skip to main content
GET
/
facilities
List all facilities
curl --request GET \
  --url https://api.simcel.io/master/v1/facilities \
  --header 'Authorization: Bearer <token>'
{
  "total": 123,
  "limit": 123,
  "skip": 123,
  "data": [
    {
      "ref": "<string>",
      "name": "<string>",
      "type": "Customer",
      "channel": "<string>",
      "subChannel": "<string>",
      "region": "<string>",
      "country": "<string>",
      "city": "<string>",
      "keyAccount": true,
      "status": "Active",
      "shipTo": "<string>",
      "groups": [
        "<string>"
      ],
      "latitude": 123,
      "longitude": 123
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
workspaceId
string
required

The workspace ID to query master data from

​
type
enum<string>

Filter by facility type

Available options:
Customer,
SecondaryCustomer,
Distributor,
DC
​
region
string
​
country
string
​
limit
integer
default:50

Maximum number of records to return (max 500)

Required range: x <= 500
​
skip
integer
default:0

Number of records to skip (for pagination)

Response

Paginated list of facilities

​
total
integer
​
limit
integer
​
skip
integer
​
data
object[]