organisation units

Organisation Units are administrative units that exist within the organisation and are rendered in the organisation chart view, for example 'Finance' or 'HR'

Get Organisation Units

SecuritybearerAuth

Responses

200

Organisation Units - Array

400

Bad Request

401

Unauthorized - Authorization Required

422

Unprocessable Entity

default

General Error

get/organisationUnits

Request samples

curl
C#
Java
PHP

Response samples

200
400
401
422
default

application/vnd.api+json

{"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/organisationUnits"
},
"data": [{"id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03",
"type": "organisationUnits",
"attributes": {"name": "Engineering",
"dateEstablished": "2001-11-17",
"unitType": "Department"
},
"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/organisationUnits/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
}
}
]
}

Create an Organisation Unit

SecuritybearerAuth

Request

Request Body schema: application/vnd.api+json

OrganisationUnit object that needs to be added

object

Responses

200

Organisation Unit

400

Bad Request

401

Unauthorized - Authorization Required

422

Unprocessable Entity

default

General Error

post/organisationUnits

Request samples

Payload
curl
C#
Java
PHP

application/vnd.api+json

{"data": {"type": "organisationUnits",
"attributes": {"name": "Engineering",
"dateEstablished": "2001-11-17",
"unitType": "Department"
},
"relationships": {"location": {"data": {"id": "1",
"type": "locations"
}
}
}
}
}

Response samples

200
400
401
422
default

application/vnd.api+json

{"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/organisationUnits"
},
"data": {"id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03",
"type": "organisationUnits",
"attributes": {"name": "Engineering",
"dateEstablished": "2001-11-17",
"unitType": "Department"
},
"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/organisationUnits/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
}
}
}

Get OrganisationUnit by ID

SecuritybearerAuth

Request

path Parameters

required

string <guid>

Organisation Unit ID

Example: 906264f1-2dff-4f72-a10b-59918cf738d7

Responses

200

Organisation Unit

400

Bad Request

401

Unauthorized - Authorization Required

404

Not Found

422

Unprocessable Entity

default

General Error

get/organisationUnits/{id}

Request samples

curl
C#
Java
PHP

Response samples

application/vnd.api+json

{"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/organisationUnits"
},
"data": {"id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03",
"type": "organisationUnits",
"attributes": {"name": "Engineering",
"dateEstablished": "2001-11-17",
"unitType": "Department"
},
"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/organisationUnits/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
}
}
}

Update an existing Organisation Unit by ID

SecuritybearerAuth

Request

path Parameters

required

string <guid>

Organisation Unit ID

Example: 906264f1-2dff-4f72-a10b-59918cf738d7

Request Body schema: application/vnd.api+json

OrganisationUnit object that needs to be updated

object

Responses

200

Organisation Unit

400

Bad Request

401

Unauthorized - Authorization Required

404

Not Found

422

Unprocessable Entity

default

General Error

patch/organisationUnits/{id}

Request samples

Payload
curl
C#
Java
PHP

application/vnd.api+json

{"data": {"type": "organisationUnits",
"attributes": {"name": "Engineering",
"dateEstablished": "2001-11-17",
"unitType": "Department"
},
"relationships": {"location": {"data": {"id": "1",
"type": "locations"
}
}
},
"id": "906264f1-2dff-4f72-a10b-59918cf738d7"
}
}

Response samples

application/vnd.api+json

{"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/organisationUnits"
},
"data": {"id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03",
"type": "organisationUnits",
"attributes": {"name": "Engineering",
"dateEstablished": "2001-11-17",
"unitType": "Department"
},
"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/organisationUnits/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
}
}
}

➔ Next to pay grades