Gets all users from company

GET /api/contact/getContactsOfCompany

Gets all users from a specific company

Query parameters

  • companyid string Required

Responses

  • default application/json

    User successfully updated

    Hide response attributes Show response attributes object
    • PASSCHANGED string(date-time)
    • EMAILBLOCKED boolean
    • datemodified string(date-time)
    • COMPANY_ID integer
    • SENDIMMEDIATE boolean
    • EMAILARCHIVE boolean
    • permissions object

      Additional properties are allowed.

      Hide permissions attributes Show permissions attributes object
      • view boolean
      • edit boolean
      • admin boolean
      • delete boolean
    • CONTACTID integer
    • MOBILE string
    • SURNAME string
    • TAILOREDDIGEST boolean
    • TEL string
    • FIRST_NAME string
    • COMPANYTYPE integer
    • STATUS string
    • COMPANYKNOWNAS string
    • COMPANYNAME string
    • JOBTITLE string
    • ACTIVE boolean
    • UNSUBSCRIBED boolean
    • roles array[object]
      Hide roles attributes Show roles attributes object
      • NAME string
      • ID integer
    • TURNOVEREMAILS string
    • EMAIL string(email)
GET /api/contact/getContactsOfCompany
curl \
 --request GET 'http://api.example.com/api/contact/getContactsOfCompany?companyid=string'
Response examples (default)
[
  {
    "PASSCHANGED": "2025-05-04T09:42:00Z",
    "EMAILBLOCKED": true,
    "datemodified": "2025-05-04T09:42:00Z",
    "COMPANY_ID": 4521,
    "SENDIMMEDIATE": true,
    "EMAILARCHIVE": true,
    "permissions": {
      "view": true,
      "edit": false,
      "admin": false,
      "delete": false
    },
    "CONTACTID": 1341,
    "MOBILE": "07777 542547",
    "SURNAME": "Miller",
    "TAILOREDDIGEST": true,
    "TEL": "020 71933777",
    "FIRST_NAME": "Tom",
    "COMPANYTYPE": 4,
    "STATUS": "away",
    "COMPANYKNOWNAS": "eBiz",
    "COMPANYNAME": "eBiz UK Ltd",
    "JOBTITLE": "Documentation Ninja",
    "ACTIVE": true,
    "UNSUBSCRIBED": true,
    "roles": [
      {
        "NAME": "View Rebates",
        "ID": 123
      }
    ],
    "TURNOVEREMAILS": "weekly",
    "EMAIL": "hello@example.com"
  }
]