HoxtonAi
Powered by Redocly

Organisations

APIs to manage Organisations.

Get organisation

Get all attributes of an organisation model given an organisation ID.

Securityo_auth
Request
path Parameters
organisationId
required
string <uuid>

The ID of the organisation to be returned.

Responses
200

OK.

401

Authentication failed.

403

Not allowed.

404

Not found.

500

Failed.

get/organisations/{organisationId}
Request samples 
Response samples 
application/json
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "licence": [
    ],
  • "maxAdminSeats": 0,
  • "maxUserSeats": 0,
  • "name": "string",
  • "processingGroup": 0,
  • "state": "active"
}
List organisations
List organisations in the portfolio.


Securityo_auth 
Request 
query Parameters
userId
string <uuid> 
The ID of a user.


 
Responses 
200
OK.


401
Authentication failed.


403
Not allowed.


422
Unprocessable entity.


500
Failed.


get/organisations
Request samples 
Response samples 
application/json
[
  • {
    }
]