Guides

Listagem de Workflows

Suggest Edits

Podemos listar todos os grupos cadastrados no sistema ou um grupo específico através de seu id.

GET /workflows

Clique aqui para testar endpoint

🚧

Todos os endpoints deverão ser autenticados

headers = {
  'Authorization': f'Bearer {api_key}'
}

Exemplo de resposta:

{
    "data": [
        {
            "contracts_count": 0,
            "id": 1300,
            "inserted_at": "2023-12-15T19:35:45",
            "is_default": true,
            "name": "Padrão",
            "organization": {
                "active": true,
                "addons": [],
                "available_proof_engines": [
                    "standard"
                ],
                "domains": [],
                "id": 1199,
                "inserted_at": "2023-12-15T19:35:45",
                "logo_url": null,
                "name": "CK API Development Corp",
                "organization_plan": null,
                "organizations_users": null,
                "statuses": null,
                "updated_at": "2024-05-17T13:36:23",
                "workflows": null
            },
            "statuses": null,
            "updated_at": "2023-12-15T19:35:45",
            "users": [
                {
                    "activated": true,
                    "activity": "Desenvolvedor Jr",
                    "cpf": "136.382.516-08",
                    "email": "[email protected]",
                    "first_name": "Davi",
                    "gender": "unspecified",
                    "id": 3056,
                    "last_name": "Ferreira",
                    "marital_status": null,
                    "organizations_users": null
                }
            ]
        },
        {
            "contracts_count": 0,
            "id": 2335,
            "inserted_at": "2024-01-26T15:27:38",
            "is_default": false,
            "name": "Departamento Financeiro da Contraktor Ltda",
            "organization": {
                "active": true,
                "addons": [],
                "available_proof_engines": [
                    "standard"
                ],
                "domains": [],
                "id": 1199,
                "inserted_at": "2023-12-15T19:35:45",
                "logo_url": null,
                "name": "CK API Development Corp",
                "organization_plan": null,
                "organizations_users": null,
                "statuses": null,
                "updated_at": "2024-05-17T13:36:23",
                "workflows": null
            },
            "statuses": null,
            "updated_at": "2024-01-26T15:27:38",
            "users": []
        },
        {
            "contracts_count": 0,
            "id": 2344,
            "inserted_at": "2024-03-18T17:35:13",
            "is_default": false,
            "name": "Jurídico",
            "organization": {
                "active": true,
                "addons": [],
                "available_proof_engines": [
                    "standard"
                ],
                "domains": [],
                "id": 1199,
                "inserted_at": "2023-12-15T19:35:45",
                "logo_url": null,
                "name": "CK API Development Corp",
                "organization_plan": null,
                "organizations_users": null,
                "statuses": null,
                "updated_at": "2024-05-17T13:36:23",
                "workflows": null
            },
            "statuses": null,
            "updated_at": "2024-03-18T17:35:13",
            "users": []
        },
        {
            "contracts_count": 0,
            "id": 2345,
            "inserted_at": "2024-03-18T17:36:01",
            "is_default": false,
            "name": "Financeiro",
            "organization": {
                "active": true,
                "addons": [],
                "available_proof_engines": [
                    "standard"
                ],
                "domains": [],
                "id": 1199,
                "inserted_at": "2023-12-15T19:35:45",
                "logo_url": null,
                "name": "CK API Development Corp",
                "organization_plan": null,
                "organizations_users": null,
                "statuses": null,
                "updated_at": "2024-05-17T13:36:23",
                "workflows": null
            },
            "statuses": null,
            "updated_at": "2024-03-18T17:36:01",
            "users": []
        },
        {
            "contracts_count": 0,
            "id": 2346,
            "inserted_at": "2024-03-19T12:50:30",
            "is_default": false,
            "name": "Justiça",
            "organization": {
                "active": true,
                "addons": [],
                "available_proof_engines": [
                    "standard"
                ],
                "domains": [],
                "id": 1199,
                "inserted_at": "2023-12-15T19:35:45",
                "logo_url": null,
                "name": "CK API Development Corp",
                "organization_plan": null,
                "organizations_users": null,
                "statuses": null,
                "updated_at": "2024-05-17T13:36:23",
                "workflows": null
            },
            "statuses": null,
            "updated_at": "2024-03-19T12:50:30",
            "users": []
        },
        {
            "contracts_count": 0,
            "id": 2385,
            "inserted_at": "2024-05-22T14:45:35",
            "is_default": false,
            "name": "Título para o workflow",
            "organization": {
                "active": true,
                "addons": [],
                "available_proof_engines": [
                    "standard"
                ],
                "domains": [],
                "id": 1199,
                "inserted_at": "2023-12-15T19:35:45",
                "logo_url": null,
                "name": "CK API Development Corp",
                "organization_plan": null,
                "organizations_users": null,
                "statuses": null,
                "updated_at": "2024-05-17T13:36:23",
                "workflows": null
            },
            "statuses": null,
            "updated_at": "2024-05-22T14:45:35",
            "users": []
        }
    ]
}

📝 O retorno desse endpoint será um array de objetos contendo todos os grupos já cadastrados.


GET /workflows/{workflow_id}

Testar endpoint

⚠️ Para listar um workflow específico, substitua o parâmetro da rota {workflow_id}, pelo valor id do grupo que deseja buscar.

Exemplo de resposta:

{
    "data": {
        "contracts_count": null,
        "id": 2385,
        "inserted_at": "2024-05-22T14:45:35",
        "is_default": false,
        "name": "Título para o workflow",
        "organization": {
            "active": true,
            "addons": [],
            "available_proof_engines": [
                "standard"
            ],
            "domains": [],
            "id": 1199,
            "inserted_at": "2023-12-15T19:35:45",
            "logo_url": null,
            "name": "CK API Development Corp",
            "organization_plan": null,
            "organizations_users": null,
            "statuses": null,
            "updated_at": "2024-05-17T13:36:23",
            "workflows": null
        },
        "statuses": null,
        "updated_at": "2024-05-22T14:45:35",
        "users": []
    }
}

Updated 3 months ago