Enterprise
Read Enterprise

Read enterprise

Get data of exisitng enterprise by id, name, email or cif parameter.

GET/enterprise/read

Parameters

identifier - integer or string required
The attribute for finding the enterprise. This can be the enterprise cif, name, email or id .


EXAMPLE
{
  "identifier": "test3@salesly.app"
}

Response

Enterprise data object.

Response
{
    "id": 12,
    "name": "Salesly.app 3",
    "email": "test3@salesly.app",
    "comments": null,
    "cif": "G1123454789",
    "phone": "938206362",
    "phone_2": null,
    "iban": null,
    "web": null,
    "public": 0,
    "last_event": null,
    "next_event": null,
    "last_opportunity_sale_date": null,
    "state": 0,
    "type": 1,
    "no_user": 0,
    "created_at": "2023-10-24 10:53:18",
    "updated_at": "2023-10-24 10:53:18",
    "deleted_at": null,
    "contacted": null,
    "mailchimp_unsubscribed": null,
    "fiscal_equal_commercial": true,
    "fiscal_name": null,
    "fiscal_address": null,
    "store_discount": null,
    "instagram": null,
    "facebook": null,
    "location": {
        "id": 11,
        "enterprise_id": 12,
        "primary": 1,
        "direction": "Carrer Gavarresa",
        "city": "Cabrianes",
        "postal": "08620",
        "country": "Spain",
        "latitude": "41.7984089",
        "longitude": "1.9100628999999572",
        "created_at": "2023-10-24 10:53:18",
        "updated_at": "2023-10-24 10:53:18",
        "deleted_at": null,
        "extra_info": null
    },
    "contacts": [
        {
            "id": 8,
            "name": "Test",
            "surname": "Contact 3",
            "surname_2": null,
            "email": "test3@contact.com",
            "phone": null,
            "phone_2": null,
            "position": null,
            "skype": null,
            "linkedin": null,
            "comments": null,
            "gender": null,
            "created_at": "2023-10-24 10:53:18",
            "updated_at": "2023-10-24 10:53:18",
            "deleted_at": null,
            "mailchimp_unsubscribed": null,
            "instagram": null,
            "facebook": null,
            "nif": null,
            "extra_field": null,
            "pivot": {
                "enterprise_id": 12,
                "contact_id": 8,
                "created_at": "2023-10-24 10:53:18",
                "updated_at": "2023-10-24 10:53:18",
                "deleted_at": null
            }
        }
    ],
    "users": [
        {
            "id": 1,
            "name": "Joan",
            "surname": null,
            "surname_2": null,
            "phone": null,
            "email": "responsible@salesly.app",
            "birth_date": null,
            "role_id": 1,
            "active": true,
            "language": "es",
            "zoom": 5,
            "latitude": "41.9",
            "longitude": "0.34",
            "remember_token": null,
            "created_at": "2023-08-03 11:16:53",
            "updated_at": "2023-10-24 10:34:27",
            "deleted_at": null,
            "last_login_session": "6536a0f061f74",
            "superadmin": true,
            "product_edition": false,
            "weekly_reports": true,
            "opportunities_default_view": 2,
            "home_kpis_layout": "[]",
            "login_type": 1,
            "role_name": "Administrador",
            "complete_name": "Joan ",
            "pivot": {
                "enterprise_id": 12,
                "user_id": 1,
                "created_at": "2023-10-24 10:53:18",
                "updated_at": "2023-10-24 10:53:18",
                "deleted_at": null
            },
            "role": {
                "id": 1,
                "name": "Administrador",
                "slug": "admin",
                "description": "Administradores",
                "color": "#3490DC",
                "created_at": "2023-08-03 11:16:49",
                "updated_at": "2023-08-03 11:16:49",
                "deleted_at": null
            }
        }
    ]
}