GET /api/organizations
List all organizations

Examples

GET /api/organizations
200
{
  "total": 3,
  "subtotal": 3,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "ancestry": null,
      "parent_id": null,
      "parent_name": null,
      "created_at": "2022-03-29 09:13:43 UTC",
      "updated_at": "2022-03-29 09:13:43 UTC",
      "id": 114267492,
      "name": "Empty Organization",
      "title": "Empty Organization",
      "description": null
    },
    {
      "ancestry": null,
      "parent_id": null,
      "parent_name": null,
      "created_at": "2022-03-29 09:13:43 UTC",
      "updated_at": "2022-03-29 09:13:43 UTC",
      "id": 447626438,
      "name": "Organization 1",
      "title": "Organization 1",
      "description": null
    },
    {
      "ancestry": null,
      "parent_id": null,
      "parent_name": null,
      "created_at": "2022-03-29 09:13:43 UTC",
      "updated_at": "2022-03-29 09:13:43 UTC",
      "id": 61304186,
      "name": "Organization 2",
      "title": "Organization 2",
      "description": null
    }
  ]
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer
search
optional

filter results

Validations:

  • Must be a String
order
optional

Sort and order by a searchable field, e.g. ‘

Maruku could not parse this XML/HTML: 
<field> DESC'

Validations:

  • Must be a String
page
optional

Page number, starting at 1

Validations:

  • Must be a number.
per_page
optional

Number of results per page to return, ‘all’ to return all results

Validations:

  • Must match regular expression /\A([1-9]\d|all)\Z$/.

Search fields

Field name Type Possible values
description text
id integer
name string
organization_id integer
title string