Skip to content

Departments

Returns list of departments in the system. Returned data can be limited with department_id query parameters.

Operations

Download departments as JSON

Request

GET https://api.zoined.com/v2/download/departments.json?limit=1000&offset=0&department_id=5401

Security
bearerAuth
Query
limitnumber

How many entries to return

Example:limit=1000
offsetnumber

Which offset to return data from

Example:offset=0
department_idstring

Returns data of department based on the given id

Example:department_id=5401
curl -i -X GET \
  'https://zapi-api.zoined.com/_mock/v2/download/departments.json?limit=1000&offset=0&department_id=5401' \
  -H 'Authorization: Bearer <YOUR_token_HERE>'

Responses

Request has been processed successfully.

Headers

  • Content-Type: application/json
Bodyapplication/json
department_idstringrequired

Department ID

Example:"5401"
namestringrequired

Department name

Example:"Web Sales"
floor_areanumber

Department area in m2

Example:100
organisation_idstring

Organisation / store this department belongs to

Example:"540"
no_customer_seatsnumber

Number of customer seats available

Example:150
custom_dimension1string

Custom Field 1

Example:"Class 3"
custom_dimension2string

Custom Field 2

Example:"Class 3"
custom_dimension3string

Custom Field 3

Example:"Class 3"
custom_dimension4string

Custom Field 4

Example:"Class 3"
custom_dimension5string

Custom Field 5

Example:"Class 3"
Response
{
  "department_id": "5401",
  "name": "Web Sales",
  "floor_area": 100,
  "organisation_id": "540",
  "no_customer_seats": 150,
  "custom_dimension1": "Class 3",
  "custom_dimension2": "Class 3",
  "custom_dimension3": "Class 3",
  "custom_dimension4": "Class 3",
  "custom_dimension5": "Class 3"
}