Businesses

Please refer to the Authentication document on how to obtain and use an API key.

Available actions & endpoints

Fetching all businesses

GET /v1/businesses (Fetch all businesses)

URL Parameters

name type data type description
None N/A N/A N/A

name	type	data type	description
None	N/A	N/A	N/A

Query Parameters

name required data type description
userUuid Yes string The uuid of the user you would like to fetch the businesses for

name	required	data type	description
userUuid	Yes	string	The uuid of the user you would like to fetch the businesses for

Responses

http code content-type response
200 application/json See example response
401 application/json {"code":401,"message": "Authentication is required to continue"}

http code	content-type	response
`200`	`application/json`	`See example response`
`401`	`application/json`	`{"code":401,"message": "Authentication is required to continue"}`

Example cURL

 curl -X GET -H "api-key: [YOUR API KEY]" https://api.monitor.insites.com/v1/businesses?userUuid=[THE userUuid]

Example Response

{
  "data": [
    {
      "uuid": "f889ff09-f506-47b2-bec4-ad0c2e058edb",
      "name": "Insites Technologies",
      "industry": "SEO",
      "reseller_uuid": "23cde63d-a219-4566-a975-199c189c3f6f",
      "created_at": "2022-11-22T13:01:19+00:00",
      "updated_at": "2023-06-22T10:28:02+00:00",
      "products": [
        "SEO audits"
      ],
      "plan_uuid": "adb515ea-969c-4c75-b6a2-a063c913a62d",
      "custom_field_values": [
        {
          "uuid": "a46c358d-353b-45b0-b138-3d650d28dc50",
          "business_uuid": "f889ff09-f506-47b2-bec4-ad0c2e058edb",
          "custom_field_uuid": "3381c631-0127-496e-b647-4ddb33aa5d25",
          "value": "Yes",
          "created_at": "2024-03-08T10:19:13+00:00",
          "updated_at": null,
          "custom_field": {
            "uuid": "3381c631-0127-496e-b647-4ddb33aa5d25",
            "reseller_uuid": "23cde63d-a219-4566-a975-199c189c3f6f",
            "name": "has_premium_plan",
            "type": "select",
            "options": ["Yes", "No"],
            "is_required": true,
            "created_at": "2024-03-08T10:19:13+00:00",
            "updated_at": null
          }
        },
        {
          "uuid": "31fcd804-1009-4929-84a0-2e477b92fdb2",
          "business_uuid": "f889ff09-f506-47b2-bec4-ad0c2e058edb",
          "custom_field_uuid": "94e33a66-f8cf-4c5d-89fe-4f7a19aeecaa",
          "value": "Ashley Jones",
          "created_at": "2024-03-08T10:19:13+00:00",
          "updated_at": null,
          "custom_field": {
            "uuid": "94e33a66-f8cf-4c5d-89fe-4f7a19aeecaa",
            "reseller_uuid": "23cde63d-a219-4566-a975-199c189c3f6f",
            "name": "account_manager_name",
            "type": "text",
            "options": null,
            "is_required": true,
            "created_at": "2024-03-08T10:19:13+00:00",
            "updated_at": null
          }
        }
      ]
    }
  ],
  "meta": {
    "per_page": 20,
    "from": 1,
    "to": 1,
    "current_page": 1,
    "last_page": 1,
    "total": 1,
    "next_page_url": null,
    "prev_page_url": null,
    "first_page_url": "http://localhost:8000/v1/businesses?page=1",
    "last_page_url": "http://localhost:8000/v1/businesses?page=1"
  }
}

Fetching a specific business

GET /v1/businesses/[business_uuid] (Fetch business)

URL Parameters

name required data type description
business_uuid Yes string The uuid of the business you would like to fetch

name	required	data type	description
business_uuid	Yes	string	The uuid of the business you would like to fetch

Query Parameters

name required data type description
None N/A N/A N/A

name	required	data type	description
None	N/A	N/A	N/A

Responses

http code content-type response
200 application/json See example response
404 application/json {"code":404,"message": "Record not found in table \"businesses\""}
401 application/json {"code":401,"message": "Authentication is required to continue"}

http code	content-type	response
`200`	`application/json`	`See example response`
`404`	`application/json`	`{"code":404,"message": "Record not found in table \"businesses\""}`
`401`	`application/json`	`{"code":401,"message": "Authentication is required to continue"}`

Example cURL

 curl -X GET https://api.monitor.insites.com/v1/businesse/[business_uuid]
      -H "api-key: [YOUR API KEY]"

Example Response

{
  "data": {
    "uuid": "f889ff09-f506-47b2-bec4-ad0c2e058edb",
    "name": "Insites Technologies",
    "industry": "SEO",
    "reseller_uuid": "23cde63d-a219-4566-a975-199c189c3f6f",
    "created_at": "2022-11-22T13:01:19+00:00",
    "updated_at": "2023-06-22T10:28:02+00:00",
    "products": [
      "SEO",
      "Website audits"
    ],
    "plan_uuid": "adb515ea-969c-4c75-b6a2-a063c913a62d",
    "custom_field_values": [
      {
        "uuid": "a46c358d-353b-45b0-b138-3d650d28dc50",
        "business_uuid": "f889ff09-f506-47b2-bec4-ad0c2e058edb",
        "custom_field_uuid": "3381c631-0127-496e-b647-4ddb33aa5d25",
        "value": "Yes",
        "created_at": "2024-03-08T10:19:13+00:00",
        "updated_at": null,
        "custom_field": {
          "uuid": "3381c631-0127-496e-b647-4ddb33aa5d25",
          "reseller_uuid": "23cde63d-a219-4566-a975-199c189c3f6f",
          "name": "has_premium_plan",
          "type": "select",
          "options": ["Yes", "No"],
          "is_required": true,
          "created_at": "2024-03-08T10:19:13+00:00",
          "updated_at": null
        }
      },
      {
        "uuid": "31fcd804-1009-4929-84a0-2e477b92fdb2",
        "business_uuid": "f889ff09-f506-47b2-bec4-ad0c2e058edb",
        "custom_field_uuid": "94e33a66-f8cf-4c5d-89fe-4f7a19aeecaa",
        "value": "Ashley Jones",
        "created_at": "2024-03-08T10:19:13+00:00",
        "updated_at": null,
        "custom_field": {
          "uuid": "94e33a66-f8cf-4c5d-89fe-4f7a19aeecaa",
          "reseller_uuid": "23cde63d-a219-4566-a975-199c189c3f6f",
          "name": "account_manager_name",
          "type": "text",
          "options": null,
          "is_required": true,
          "created_at": "2024-03-08T10:19:13+00:00",
          "updated_at": null
        }
      }
    ]
  }
}

Creating a business

POST /v1/businesses (Create business)

URL Parameters

name required data type description
None N/A N/A N/A

name	required	data type	description
None	N/A	N/A	N/A

Query Parameters

name required data type description
userUuid Yes string The uuid of the user you would like to create a business for

name	required	data type	description
userUuid	Yes	string	The uuid of the user you would like to create a business for

Responses

http code content-type response
200 application/json See example response
422 application/json {"success":false,"message":"error","errors":{"name":{"length":"Business name must be < 100 characters"}}}
401 application/json {"code":401,"message": "Authentication is required to continue"}

http code	content-type	response
`200`	`application/json`	`See example response`
`422`	`application/json`	`{"success":false,"message":"error","errors":{"name":{"length":"Business name must be < 100 characters"}}}`
`401`	`application/json`	`{"code":401,"message": "Authentication is required to continue"}`

Example cURL

 curl -X POST https://api.monitor.insites.com/v1/businesses
      -H "api-key: [YOUR API KEY]"
      -H "Content-Type: application/json"
      -d "[SEE EXAMPLE REQUEST BODY]"

Example Request Body

{
  "name": "Insites Technologies",
  "industry": "SEO",
  "products": [
    "SEO",
    "Website audits"
  ],
  "custom_fields": [
    {
      "has_premium_plan": "Yes"
    },
    {
      "account_manager_name": "Ashley Jones"
    }
  ]
}

Example Response

{
  "message": "success",
  "success": true,
  "data": {
    "uuid": "f889ff09-f506-47b2-bec4-ad0c2e058edb",
    "name": "Insites Technologies",
    "industry": "SEO",
    "reseller_uuid": "23cde63d-a219-4566-a975-199c189c3f6f",
    "created_at": "2022-11-22T13:01:19+00:00",
    "updated_at": "2023-06-22T10:28:02+00:00",
    "products": [
      "SEO",
      "Website audits"
    ],
    "plan_uuid": "adb515ea-969c-4c75-b6a2-a063c913a62d",
    "custom_field_values": [
      {
        "uuid": "a46c358d-353b-45b0-b138-3d650d28dc50",
        "business_uuid": "f889ff09-f506-47b2-bec4-ad0c2e058edb",
        "custom_field_uuid": "3381c631-0127-496e-b647-4ddb33aa5d25",
        "value": "Yes",
        "created_at": "2024-03-08T10:19:13+00:00",
        "updated_at": null,
        "custom_field": {
          "uuid": "3381c631-0127-496e-b647-4ddb33aa5d25",
          "reseller_uuid": "23cde63d-a219-4566-a975-199c189c3f6f",
          "name": "has_premium_plan",
          "type": "select",
          "options": ["Yes", "No"],
          "is_required": true,
          "created_at": "2024-03-08T10:19:13+00:00",
          "updated_at": null
        }
      },
      {
        "uuid": "31fcd804-1009-4929-84a0-2e477b92fdb2",
        "business_uuid": "f889ff09-f506-47b2-bec4-ad0c2e058edb",
        "custom_field_uuid": "94e33a66-f8cf-4c5d-89fe-4f7a19aeecaa",
        "value": "Ashley Jones",
        "created_at": "2024-03-08T10:19:13+00:00",
        "updated_at": null,
        "custom_field": {
          "uuid": "94e33a66-f8cf-4c5d-89fe-4f7a19aeecaa",
          "reseller_uuid": "23cde63d-a219-4566-a975-199c189c3f6f",
          "name": "account_manager_name",
          "type": "text",
          "options": null,
          "is_required": true,
          "created_at": "2024-03-08T10:19:13+00:00",
          "updated_at": null
        }
      }
    ]
  }
}

Updating a business

PATCH /v1/businesses/[business_uuid] (Update business)

URL Parameters

name required data type description
business_uuid Yes string The uuid of the business you would like to update

name	required	data type	description
business_uuid	Yes	string	The uuid of the business you would like to update

Query Parameters

name required data type description
None N/A N/A N/A

name	required	data type	description
None	N/A	N/A	N/A

Responses

http code content-type response
200 application/json See example response
422 application/json {"success":false,"message":"error","errors":{"name":{"length":"Business name must be < 100 characters"}}}
401 application/json {"code":401,"message": "Authentication is required to continue"}

http code	content-type	response
`200`	`application/json`	`See example response`
`422`	`application/json`	`{"success":false,"message":"error","errors":{"name":{"length":"Business name must be < 100 characters"}}}`
`401`	`application/json`	`{"code":401,"message": "Authentication is required to continue"}`

Example cURL

 curl -X PATCH https://api.monitor.insites.com/v1/businesse/[business_uuid]
      -H "api-key: [YOUR API KEY]"
      -H "Content-Type: application/json"
      -d "[SEE EXAMPLE REQUEST BODY]"

Example Request Body

{
  "name": "Insites Technologies LTD",
  "industry": "SEO",
  "products": [
    "SEO",
    "Website audits"
  ]
}

Example Response

{
  "message": "success",
  "success": true,
  "data": {
    "uuid": "f889ff09-f506-47b2-bec4-ad0c2e058edb",
    "name": "Insites Technologies LTD",
    "industry": "SEO",
    "reseller_uuid": "23cde63d-a219-4566-a975-199c189c3f6f",
    "created_at": "2022-11-22T13:01:19+00:00",
    "updated_at": "2023-06-22T10:28:02+00:00",
    "products": [
      "SEO",
      "Website audits"
    ],
    "plan_uuid": "adb515ea-969c-4c75-b6a2-a063c913a62d"
  }
}

Deleting a business

DELETE /v1/businesses/[business_uuid] (Delete business)

URL Parameters

name required data type description
business_uuid Yes string The uuid of the business you would like to delete

name	required	data type	description
business_uuid	Yes	string	The uuid of the business you would like to delete

Query Parameters

name required data type description
None N/A N/A N/A

name	required	data type	description
None	N/A	N/A	N/A

Responses

http code content-type response
200 application/json {"success":true,"message":"success"}
401 application/json {"code":401,"message": "Authentication is required to continue"}

http code	content-type	response
`200`	`application/json`	`{"success":true,"message":"success"}`
`401`	`application/json`	`{"code":401,"message": "Authentication is required to continue"}`

Example cURL

 curl -X DELETE https://api.monitor.insites.com/v1/businesse/[business_uuid]
      -H "api-key: [YOUR API KEY]"

Available actions & endpoints​

Fetching all businesses​

URL Parameters​

Query Parameters​

Responses​

Example cURL​

Example Response​

Fetching a specific business​

URL Parameters​

Query Parameters​

Responses​

Example cURL​

Example Response​

Creating a business​

URL Parameters​

Query Parameters​

Responses​

Example cURL​

Example Request Body​

Example Response​

Updating a business​

URL Parameters​

Query Parameters​

Responses​

Example cURL​

Example Request Body​

Example Response​

Deleting a business​

URL Parameters​

Query Parameters​

Responses​

Example cURL​

Available actions & endpoints

Fetching all businesses

URL Parameters

Query Parameters

Responses

Example cURL

Example Response

Fetching a specific business

URL Parameters

Query Parameters

Responses

Example cURL

Example Response

Creating a business

URL Parameters

Query Parameters

Responses

Example cURL

Example Request Body

Example Response

Updating a business

URL Parameters

Query Parameters

Responses

Example cURL

Example Request Body

Example Response

Deleting a business

URL Parameters

Query Parameters

Responses

Example cURL