Listar todas as organizações

GET

https://api.cubosuite.com.br/organizations

Descrição

Retorna uma lista paginada de organizações da empresa do usuário autenticado, com suporte a filtros e ordenação.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.cubosuite.com.br/organizations?company_id=52&limit=10&page=1&orderColumn=created_at&orderDirection=asc'

Response Example

{
    "meta": {
        "total": 2467,
        "per_page": 10,
        "current_page": 1,
        "last_page": 247,
        "first_page": 1,
        "first_page_url": "/?page=1",
        "last_page_url": "/?page=247",
        "next_page_url": "/?page=2",
        "previous_page_url": null
    },
    "data": [
        {
            "id": 863,
            "name": "Cubo",
            "status": "active",
            "companyId": 1,
            "userId": 52,
            "createdAt": "2021-10-21T18:59:46.000-03:00",
            "updatedAt": null,
            "user": {
                "id": 52,
                "name": "CuboCRM",
                "phone": "(17) 99218-2270",
                "email": "cubocrm@cubocrm.com.br",
                "status": "active",
                "type": "administrator",
                "picture": "https://files.cubocrm.com.br/user/default-user-avatar.jpg",
                "companyId": 1,
                "defaultPipe": null,
                "rememberMeToken": null,
                "createdAt": "2020-12-14T22:12:58.000-03:00",
                "updatedAt": "2025-04-09T13:49:29.000-03:00",
                "sendNotificationWhatsapp": true,
                "manychatContactId": 950438185,
                "messagesAtOnce": 100,
                "meta": {
                    "google_refresh_token": null
                }
            },
            "customfields": [],
            "annotations": [
                {
                    "dealId": null,
                    "organizationId": 863,
                    "peopleId": null,
                    "activityId": null,
                    "id": 67506,
                    "text": "Organização criada",
                    "userId": 52,
                    "type": "alteration",
                    "createdAt": "2021-10-21T18:59:46.000-03:00",
                    "updatedAt": null,
                    "user": {
                        "id": 52,
                        "name": "CuboCRM",
                        "phone": "(17) 99218-2270",
                        "email": "cubocrm@cubocrm.com.br",
                        "status": "active",
                        "type": "administrator",
                        "picture": "https://files.cubocrm.com.br/user/default-user-avatar.jpg",
                        "companyId": 1,
                        "defaultPipe": null,
                        "rememberMeToken": null,
                        "createdAt": "2020-12-14T22:12:58.000-03:00",
                        "updatedAt": "2025-04-09T13:49:29.000-03:00",
                        "sendNotificationWhatsapp": true,
                        "manychatContactId": 950438185,
                        "messagesAtOnce": 100,
                        "meta": {
                            "google_refresh_token": null
                        }
                    }
                }
            ]
        }
    ]
}

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

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

Parâmetros Query

company_id

string

requerido

Exemplo:

limit

number

opcional

Número de itens por página (Padrão = 10 ou Max = 100).

Exemplo:

page

number

opcional

Página atual da paginação.

Exemplo:

orderColumn

string

opcional

Coluna utilizada para ordenação.

Exemplo:

created_at

orderDirection

string

opcional

Direção da ordenação (asc ou desc).

Exemplo:

asc

Respostas

🟢200Success

application/json

Body

Listar todas as organizações

Descrição#

Requisição

Respostas

Descrição