Organisations API

v1.0 • REST • JSON

Full CRUD management for organisation accounts. Create, retrieve, update, and delete organisation records with built-in pagination and role-based access control support.

GET POST PUT DELETE 5 Endpoints
Base URL https://bogusapi.com/api/organisations

Quick Reference

GET
/api/organisations List all organisations (paginated)
200 GET
/api/organisations/{id} Get one organisation by ID
200 POST
/api/organisations Create a new organisation
201 PUT
/api/organisations/{id} Replace organisation data
204 DEL
/api/organisations/{id} Remove a organisation
204 GET
/api/organisations/{id} Organisation not found example
404
GET /api/organisations 200 OK

Get All Organisations

Retrieves a paginated list of all organisations in the system. Use the page and limit query parameters to navigate large result sets. The response envelope includes total count and page metadata.

Query Parameters
ParameterTypeDefaultDescription
page integer 1 Page number, 1-based index
limit integer 10 Number of records per page
Response: 200 OK
GET /api/organisations/{id} 200 OK

Get Single Organisation

Fetch the full profile for a specific organisation using their numeric ID. Returns all organisation fields including assigned role names and account metadata.

Path Parameters
ParameterTypeRequiredDescription
id integer Required Unique organisation identifier
Response: 200 OK
GET /api/organisations/{id} 404 Not Found

Organisation Not Found

Returned when the requested organisation ID does not exist in the system. Use this example to test error-handling logic and build graceful fallback UI for missing organisation resources.

Response: 404 Not Found
POST /api/organisations 201 Created

Create Organisation

Registers a new organisation with the provided details. On success, returns the newly created organisation object including the auto-generated ID, timestamp, and resolved role names.

Request Body
Field Type Required Description
name string Required Name
description string Optional Description
teams string[] Optional Teams
Body
Response: 201 Created
PUT /api/organisations/{id} 200 OK

Update Organisation

Fully replaces an existing organisation's data with the values in the request body. A successful update returns 200 OK with response body.

Request Body
Field Type Required Description
name string Required Name
description string Optional Description
teams string[] Optional Teams
Body
Response: 200 OK
DELETE /api/organisations/{id} 204 No Content

Delete Organisation

Permanently removes a organisation from the system by their ID. This action is irreversible once deleted, the organisation record and all associated data cannot be recovered through the API.

Path Parameters
ParameterTypeRequiredDescription
id integer Required ID of the organisation to delete
Response: 204 No Content