GET /organization

https://api.suitsbooks.nl/organization

Query parameters

name	required	default
organization_id	true	null
access_groups_column_filter	false	null

organization_id

Isomorphic UUID that uniquely identifies an organization object

access_groups_column_filter

Singular filter value that can be used to narrow down the access_groups array object that is returned IF the company is a slave of an access_group

Possible filters:

auth_index
company_id
exp_date
flagged
frozen
invite_code
invited_by_user_id
organization_id
pending
role ««« Role’s should only be consumed from this fetch as a read-only, as this role describes the underlying user_id role within this company
scopes
status
time
user_id « « This is safe but if you need direct user_id →company_id access you should use GET /user

{
    "data": [
        {
            "access_groups": [
                {
                    "auth_index": 10,
                    "company_id": "a9478456-a9ef-41ef-85c6-9b0633f4f757",
                    "created_at": "2025-02-16T04:45:40.017749+00:00",
                    "exp_date": 0,
                    "flagged": false,
                    "frozen": false,
                    "id": 2,
                    "invite_code": null,
                    "invited_by_user_id": "fab9b58e-8592-4f0e-b4a3-a2efe6e77503",
                    "organization_id": "604639d0-d93c-4c15-b075-add82bb44640",
                    "pending": false,
                    "role": "developer",
                    "scopes": null,
                    "status": "actvie",
                    "time": 1739681109,
                    "user_id": "a29faa58-3d54-412e-b071-679912d9ac35"
                }
            ],
            "avatar": "https://studio.xylex.ai/storage/v1/object/public/org_pfp/xylex.png",
            "billing_address_line_1": null,
            "billing_address_line_2": null,
            "billing_city": null,
            "billing_company_name": null,
            "billing_country": null,
            "billing_email": "floris@xylex.ai",
            "billing_invoice_language": "en",
            "billing_postal_code": null,
            "billing_state": null,
            "bio": null,
            "created_at": "2025-02-15T22:37:11.720815+00:00",
            "id": 1,
            "name": "xylex",
            "organization_id": "604639d0-d93c-4c15-b075-add82bb44640",
            "tier": null,
            "verified": true
        }
    ],
    "message": "Fetch organization metadata successfully",
    "success": true
}