Karia
ReferencesOpenapiOrganisation

List organisations

GET
/organisation

List organisations the API key owner can access, with optional search and pagination.

Authorization

ApiKeyAuth
x-api-key<token>

API key for authentication

In: header

Query Parameters

search?string
page?number
Default1
Range1 <= value
limit?number
Default10
Range1 <= value <= 50

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://app.np.aws.karia.com.au/api/v0/organisation"
{
  "items": [
    {
      "id": 0,
      "name": "string",
      "tradingName": "string",
      "url": "string",
      "createdAt": "string",
      "apiAccessEnabled": true
    }
  ],
  "pagination": {
    "total": 0,
    "page": 0,
    "limit": 0,
    "totalPages": 0
  }
}
{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}
{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}
{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}
{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}
{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}