Organisations

This object represents an organisation and/or its child organisations. Child organisations allow for complex organisational structures, enabling hierarchical management and inheritance of properties and settings. Parent organisations, or Felloh, can update settings depending on their subscription level.

Organisation Model

Properties

Name
id
Type
string
Description
Unique identifier for the organisation.
Name
name
Type
string
Description
The name of the organisation.
Name
created_at
Type
datetime
Description
The datetime when the organisation was created within our systems.
Name
parent
Type
string
Description
The ID of the parent organisation, if applicable. When the parent organisation is also within your access, the full parent organisation object is returned in its place.

{
  "id": "X00001",
  "name": "Felloh",
  "created_at": "2022-01-15T00:48:42.091Z",
  "updated_at": "2022-01-18T11:27:25.018Z",
  "parent": {
    "id": "X00002",
    "name": "Big Corp"
  }
}

GET/user/organisations

Fetch All

This endpoint retrieves all organisations accessible in the authenticated session.

Request

GET

/user/organisations

import axios from 'axios';

const response = await axios.get(
  'https://api.felloh.com/user/organisations',
  {
    headers: { 'Content-Type': 'application/json', 'Authorization': `Bearer <YOUR TOKEN HERE>` }
  }
);

Response

{
  "data": [
    {
      "created_at": "2022-01-15T00:48:42.091Z",
      "currencies" : [
          "GBX"
      ],
      "deleted_at" : null,
      "features" : [
          {
            "created_at" : "2022-01-15T01:10:35.687Z",
            "id" : "ded40f5c-9d82-44c2-92e3-b5d2cad364f6",
            "machine_name" : "booking-and-payment",
            "name" : "Booking & Payment"
          },
          {
            "created_at" : "2022-07-27T22:17:51.389Z",
            "id" : "efd40f5c-9d82-44c2-92e3-b5d2cad364f6",
            "machine_name" : "chargebacks",
            "name" : "Chargebacks"
          },
      ],
      "id" : "X00001",
      "image" : null,
      "legacy_id" : "bcd40f5c-9d82-44c2-92e3-b5d2cad364f6",
      "name" : "Felloh",
      "parent" : "X00002",
      "payment_methods" : [
          "MOTO_IN_PERSON",
          "MOTO_OTHER",
          "ONLINE"
      ]
    }
  ],
  "errors": [],
  "meta": {
    "code": 200,
    "reason": "OK",
    "message": "The request was successful",
    "request_id": "cdd40f5c-9d82-44c2-92e3-b5d2cad364f6"
  }
}