GET /company

https://api.suitsbooks.nl/company

Query parameters

name	required	default
company_id	true	null
access_groups_column_filter	false	null

company_id

Isomorphic UUID that uniquely identifies a company 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

Response objects

`Example 1: Company with two access_groups`

This company is a consumer of 2 access_groups with no filter that was passed

{
    "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"
                },
                {
                    "auth_index": 0,
                    "company_id": "a9478456-a9ef-41ef-85c6-9b0633f4f757",
                    "created_at": "2025-02-16T10:56:36.214684+00:00",
                    "exp_date": null,
                    "flagged": false,
                    "frozen": false,
                    "id": 3,
                    "invite_code": null,
                    "invited_by_user_id": null,
                    "organization_id": "655c1024-a0c2-42b0-8520-c73c540372d1",
                    "pending": true,
                    "role": null,
                    "scopes": null,
                    "status": null,
                    "time": null,
                    "user_id": "fab9b58e-8592-4f0e-b4a3-a2efe6e77503"
                }
            ],
            "company_id": "a9478456-a9ef-41ef-85c6-9b0633f4f757",
            "created_at": "2025-02-15T22:56:04.398656+00:00",
            "id": 6,
            "name": "xylex cloud",
            "owner_user_id": "a29faa58-3d54-412e-b071-679912d9ac35"
        }
    ],
    "message": "Fetch company metadata successfully",
    "success": true
}

`Example 2: Company with 2 access_groups and filter organization_id`

{
    "data": [
        {
            "access_groups": [
                {
                    "organization_id": "604639d0-d93c-4c15-b075-add82bb44640"
                },
                {
                    "organization_id": "655c1024-a0c2-42b0-8520-c73c540372d1"
                }
            ],
            "company_id": "a9478456-a9ef-41ef-85c6-9b0633f4f757",
            "created_at": "2025-02-15T22:56:04.398656+00:00",
            "id": 6,
            "name": "xylex cloud",
            "owner_user_id": "a29faa58-3d54-412e-b071-679912d9ac35"
        }
    ],
    "message": "Fetch company metadata successfully",
    "success": true
}