GET
/
v3
/
orgs
curl --request GET \
  --url https://api.ctrl-hub.com/v3/orgs \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "type": "organisations",
      "id": "7e0c875a-fd47-401d-bd25-4278ed58d721",
      "attributes": {
        "name": "Ctrl Hub",
        "slug": "ctrl-hub",
        "description": "Ctrl Hub deliver best in class software for managing your compliance, safety, risk and resource requirements",
        "settings": {
          "nomenclature": {
            "governance": {
              "schemes": [
                {
                  "language": "en-GB",
                  "singular": "Scheme",
                  "plural": "Schemes"
                }
              ],
              "work_orders": [
                {
                  "language": "en-GB",
                  "singular": "Work Order",
                  "plural": "Work Orders"
                }
              ],
              "operations": [
                {
                  "language": "en-GB",
                  "singular": "Operation",
                  "plural": "Operations"
                }
              ]
            }
          }
        }
      },
      "meta": {
        "created_at": "2024-06-13T07:15:23.000Z",
        "status": "active"
      },
      "links": {
        "self": "https://api.ctrl-hub.com/v3/orgs/7e0c875a-fd47-401d-bd25-4278ed58d721"
      }
    }
  ],
  "meta": {
    "counts": {
      "limit": 10
    },
    "page": {
      "limit": 10,
      "offset": {
        "current": 20,
        "next": 30,
        "previous": 10
      }
    }
  },
  "links": {
    "current": "https://api.ctrl-hub.com/v3/orgs?limit=10&offset=20",
    "next": "https://api.ctrl-hub.com/v3/orgs?limit=10&offset=30",
    "previous": "https://api.ctrl-hub.com/v3/orgs?limit=10&offset=10"
  }
}

​
Sort Support

Resources can be sorted by name, slug, status or created_at

Authorizations

​
Authorization
string
header
required

To understand how to authenticate, see the auth docs

Query Parameters

​
limit
integer
default:
10

Limit the number of resources returned by the API

​
offset
integer
default:
0

Offset for resources returned by the API

​
sort
string
default:
created_at

A field in the resource to sort results with. Not all attributes are supported, please see the Object Model for sortable fields.

Response

200
application/json
​
data
object[]
​
meta
object
​
links
object
Organisation ModelGet an Organisation