Getting Started

Initial setup process in order to use Agency Handy API.

Step 1: Generate an API Key

1. Go to: {{workspaceUrl}}/workspace-config?tab=api-keyGenerate

2. Copy the API key.

Step 2: Get Company ID

📍 Endpoint:

{{URL}}/accounts/companies

🛠️ Set Headers:

x-api-key: <API_KEY>

📥 Response Example:

{
  "message": "Companies associated with API token.",
  "companies": [
    {
      "_id": "6525994184e9ddd79853450e",
      "name": "onethread123",
      "logo": "",
      "extraSmallLogo": "",
      "largeLogo": ""
    }
  ]
}

📝 What to Do:

• Extract the Company ID from the response: companies[0]._id.

• Store the ID for later use:

  const companyid = "COMPANY_ID_HERE"; // Replace with actual ID