Organization API

User organizations

Endpoint

Method URI Headers
GET /v3/organizations Default

This enpoint returns organizations a user belongs to along with group information under each organization. No parameters are required.


Single organization

Endpoint

Method URI Headers
GET /v3/organizations/{id} Default

This enpoint returns organization details including groups. User requesting this resource must be in the organization.

URL Params

{
    "id"    : $organizationId
}

Response

{
    "id": 6,
    "name": "ChamberForge",
    "created_at": "2018-02-09 17:37:26",
    "updated_at": "2022-01-22 17:35:13",
    "groups": [
        {
            "id": 33,
            "name": "Northern Virginia Referral Group",
            "created_at": "2021-11-10 10:05:38",
            "updated_at": "2022-02-10 21:14:31"
        },
        {
            "id": 136,
            "name": "Washington DC Referral Group",
            "created_at": "2020-01-17 13:43:06",
            "updated_at": "2022-02-23 00:10:32"
        }
    ]
}