<aside> 💡 The various API methods for accessing organisation information.

</aside>

Get an organisation

All authenticated Hail users can view the public information of an organisation. Owners have slightly more detail, including the date the organisation was created.

Endpoint

GET v1/organisations/{id}

Response Codes

200 OK The request was successful

Response Body

All authenticated users will see the the following fields:

field type description
id string The unique identifier of the organisation
name string A name for the organisation
slug string The URL slug for the organisation
email string An email address for the public to contact the organisation
website_url string The URL to the organisation's website
facebook_url string The URL to the organisation's Facebook page
twitter_username string The organisation's Twitter username / handle. Omit the leading @ symbol.
youtube_url string The URL to the organisation's YouTube channel
google_url string The URL to the organisation's Google+ page
privacy_policy_url string The URL to the organisation's privacy policy
terms_url string The URL to the organisation's terms and conditions
avatar_url string The URL to the organisation's 500x500 avatar
small_avatar_url string The URL to the organisation's 75x75 avatar
country* object The country where the organisation is based. See the Countries documentation
is_suspended* boolean Whether the organisation is suspended or not
active_subscription* boolean Whether the organisation's subscription is active or not. If not, only billing resources will be available to the organisation owner to activate the subscription by paying overdue invoices
active_credit_card* boolean Whether the organisation has a working credit card
created_date* string The date (in format YYYY-MM-DD HH:MM:SS) the organisation was created

Example Response Body

{
    "id": "q74kfel",
    "name": "Logan Park High School",
    "email": "[email protected]",
    "website_url": "http:\\/\\/www.lphs.school.nz",
    "facebook_url": "https:\\/\\/www.facebook.com\\/LoganParkHighSchool",
    "twitter_url": null,
    "youtube_url": "https:\\/\\/www.youtube.com\\/channel\\/UC5BQzdjSQOyUDlkBkANwPwA",
    "google_url": null,
    "privacy_policy_url": "http:\\/\\/www.lphs.school.nz\\/sites\\/lphs.school.nz\\/files\\/documents\\/LPHS%202013%20All%20Policies%20Manual%20-%20working%20documentV5_0.pdf",
    "terms_url": null,
    "avatar_url": null,
    "small_avatar_url": null,
    "country": {
        "id": "NZ",
        "name": "New Zealand",
        "currency": "NZD"
    },
    "is_suspended": false,
    "active_subscription": true,
    "active_credit_card": true,
    "created_date": "2014-04-01 02:25:36"
}

Get an organisation's stats

Endpoint

GET v1/organisations/{id}/stats

Response Codes

200 OK Organisation updated successfully
403 Not Authorised The user is not a member of the organisation

Response Body

field type description
maximum_allowed_members number The maximum number of members allowed in the organisation, given the plan currently subscribed to
member_count number The current number of members in the organisation
invite_count number The number of outstanding invitations in the organisation