Get Companies

GET

https://primaryapi.cicle.app/api/v1/companies

Last modified:2026-07-02 05:57:53

Maintainer:Putu Aditya

Retrieve all companies for the authenticated user. Returns companies where the user is a member.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Responses

🟢200Success

application/json

Companies retrieved successfully

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://primaryapi.cicle.app/api/v1/companies' \
--header 'Authorization: Bearer <token>'

Response Example

{
    "companies": [
        {
            "_id": "string",
            "name": "string",
            "desc": "string",
            "logo": "string",
            "creator": "string",
            "admins": [
                "string"
            ],
            "managers": [
                "string"
            ],
            "spvs": [
                "string"
            ],
            "membersJoined": [
                {
                    "member": "string",
                    "joinedAt": "string"
                }
            ],
            "members": [
                {
                    "_id": "string",
                    "fullName": "string",
                    "photoUrl": "string",
                    "status": "string",
                    "bio": "string"
                }
            ],
            "teams": [
                {
                    "_id": "string",
                    "name": "string",
                    "desc": "string",
                    "creator": "string",
                    "company": "string",
                    "type": "string",
                    "members": [
                        {
                            "_id": "string",
                            "photoUrl": "string"
                        }
                    ],
                    "boards": [
                        "string"
                    ],
                    "bucket": "string",
                    "groupChat": "string",
                    "blast": "string",
                    "checkIn": "string",
                    "schedule": "string",
                    "archived": {
                        "status": true,
                        "archivedAt": "string"
                    },
                    "createdAt": "string",
                    "updatedAt": "string"
                }
            ],
            "workloadCapacityDefault": {
                "value": 0,
                "measurement": "string"
            },
            "archived": {
                "status": true,
                "archivedAt": "string"
            },
            "metrics": {
                "country": "string",
                "marketing": "string",
                "payment": "string"
            },
            "createdAt": "string",
            "updatedAt": "string"
        }
    ]
}

Overview