Companies

get

Query parameters

pageintegerOptionalDefault: 1

Responses

200

Successful response

application/json

totalCountnumberRequired

totalPagesnumberRequired

currentPagenumberRequired

default

Error response

application/json

get

/companies

HTTPcURLJavaScriptPython

GET /api/v1/companies HTTP/1.1
Host: app.companycontacts.timeghost-solutions.com
Accept: */*

{
  "companies": [
    {
      "id": 1,
      "title": "text",
      "email": "text",
      "industry": "text",
      "note": "text",
      "image": "text",
      "isDeleted": true,
      "description": "text",
      "createdAt": "2026-03-11T23:10:25.101Z",
      "updatedAt": "2026-03-11T23:10:25.101Z",
      "addresses": [
        {
          "id": "text",
          "country": "text",
          "city": "text",
          "state": "text",
          "street": "text",
          "zip": "text",
          "timeZone": "text",
          "companyId": 1
        }
      ],
      "websites": [
        {
          "id": "text",
          "title": "text"
        }
      ],
      "vaults": [
        {
          "vaultId": "text",
          "vault": {
            "id": "text",
            "title": "text",
            "description": "text",
            "createdAt": "2026-03-11T23:10:25.101Z",
            "updatedAt": "2026-03-11T23:10:25.101Z",
            "workspaceId": "text",
            "default": true
          }
        }
      ]
    }
  ],
  "totalCount": 1,
  "totalPages": 1,
  "currentPage": 1
}

post

Body

application/json

titlestringRequired

emailstringOptional

industrystringOptional

notestringOptional

descriptionstringOptional

phoneNumberstringOptional

imagestringOptional

vaultIdsstring[]Required

Responses

200

Successful response

application/json

idnumberRequired

titlestringRequired

emailstring · nullableRequired

industrystring · nullableRequired

notestring · nullableRequired

imagestring · nullableRequired

isDeletedbooleanRequired

descriptionstring · nullableRequired

createdAtstring · date-timeRequired

updatedAtstring · date-timeRequired

default

Error response

application/json

post

/companies

HTTPcURLJavaScriptPython

POST /api/v1/companies HTTP/1.1
Host: app.companycontacts.timeghost-solutions.com
Content-Type: application/json
Accept: */*
Content-Length: 140

{
  "title": "text",
  "email": "text",
  "industry": "text",
  "note": "text",
  "description": "text",
  "phoneNumber": "text",
  "image": "text",
  "vaultIds": [
    "text"
  ]
}

{
  "id": 1,
  "title": "text",
  "email": "text",
  "industry": "text",
  "note": "text",
  "image": "text",
  "isDeleted": true,
  "description": "text",
  "createdAt": "2026-03-11T23:10:25.101Z",
  "updatedAt": "2026-03-11T23:10:25.101Z"
}

get

Path parameters

idnumberRequired

Responses

200

Successful response

application/json

idnumberRequired

titlestringRequired

emailstring · nullableRequired

industrystring · nullableRequired

notestring · nullableRequired

imagestring · nullableRequired

isDeletedboolean · nullableRequired

descriptionstring · nullableRequired

createdAtstring · date-timeRequired

updatedAtstring · date-timeRequired

default

Error response

application/json

get

/companies/{id}

HTTPcURLJavaScriptPython

GET /api/v1/companies/{id} HTTP/1.1
Host: app.companycontacts.timeghost-solutions.com
Accept: */*

{
  "id": 1,
  "title": "text",
  "email": "text",
  "industry": "text",
  "note": "text",
  "image": "text",
  "isDeleted": true,
  "description": "text",
  "createdAt": "2026-03-11T23:10:25.101Z",
  "updatedAt": "2026-03-11T23:10:25.101Z",
  "addresses": [
    {
      "id": "text",
      "country": "text",
      "city": "text",
      "state": "text",
      "street": "text",
      "zip": "text",
      "timeZone": "text",
      "companyId": 1
    }
  ],
  "websites": [
    {
      "id": "text",
      "title": "text"
    }
  ],
  "vaults": [
    {
      "vaultId": "text",
      "vault": {
        "id": "text",
        "title": "text",
        "description": "text",
        "createdAt": "2026-03-11T23:10:25.101Z",
        "updatedAt": "2026-03-11T23:10:25.101Z",
        "workspaceId": "text",
        "default": true
      }
    }
  ],
  "workspace": {
    "title": "text",
    "createdAt": "2026-03-11T23:10:25.101Z"
  }
}

put

Path parameters

idnumberRequired

Body

application/json

titlestringRequired

emailstring · nullableRequired

phoneNumberstring · nullableRequired

industrystring · nullableRequired

notestring · nullableRequired

descriptionstring · nullableRequired

vaultIdsstring[]Required

Responses

200

Successful response

application/json

idnumberRequired

titlestringRequired

emailstring · nullableRequired

phoneNumberstring · nullableRequired

industrystring · nullableRequired

notestring · nullableRequired

descriptionstring · nullableRequired

updatedAtstring · date-timeRequired

default

Error response

application/json

put

/companies/{id}

HTTPcURLJavaScriptPython

PUT /api/v1/companies/{id} HTTP/1.1
Host: app.companycontacts.timeghost-solutions.com
Content-Type: application/json
Accept: */*
Content-Length: 125

{
  "title": "text",
  "email": "text",
  "phoneNumber": "text",
  "industry": "text",
  "note": "text",
  "description": "text",
  "vaultIds": [
    "text"
  ]
}

{
  "id": 1,
  "title": "text",
  "email": "text",
  "phoneNumber": "text",
  "industry": "text",
  "note": "text",
  "description": "text",
  "updatedAt": "2026-03-11T23:10:25.101Z"
}

delete

Path parameters

idstringRequired

Responses

200

Successful response

application/json

objectOptional

default

Error response

application/json

delete

/companies/{id}

HTTPcURLJavaScriptPython

DELETE /api/v1/companies/{id} HTTP/1.1
Host: app.companycontacts.timeghost-solutions.com
Accept: */*

{}