GetAllUsers | HeyReach API Documentation

curl -X POST https://api/api/public/management/organizations/users \
     -H "Content-Type: application/json" \
     -d '{
  "offset": 895,
  "role": "Admin",
  "invitationStatus": [
    "Accepted",
    "Pending"
  ],
  "limit": 38
}'

{
  "totalCount": 3087,
  "items": [
    {
      "userDetails": {
        "userId": 5043,
        "name": "string",
        "surname": "string",
        "email": "string",
        "roles": [
          "string",
          "string"
        ]
      },
      "userInvitation": {
        "invitationId": 1790,
        "invitationStatus": "Unknown",
        "invitationUrl": "string",
        "expirationTime": "2004-02-14T23:23:22Z"
      },
      "organizationPermissions": {
        "userDeactivate": false,
        "manageWorkspace": false,
        "manageWorkspaceMembers": false,
        "viewBilling": false,
        "manageBlling": false,
        "manageBillingDetails": false,
        "accessBillingInvoiceHistoy": false
      },
      "workspacesPermissions": [
        {
          "workspaceName": "string",
          "workspaceId": 6948,
          "permissions": {
            "viewLinkedInSenders": false,
            "manageLinkedInSendersSettings": false,
            "viewLeadLists": false,
            "importEditManageLeadLists": false,
            "viewMyNetwork": false,
            "viewCampaigns": false,
            "editManageCampaigns": false,
            "viewLinkedInSenderInboxes": false,
            "replyFromLinkedInSenderInboxes": false,
            "viewIntegrations": false,
            "manageIntegrations": false,
            "exportDataToCRMs": false,
            "viewNotifications": false,
            "manageNotifications": false
          }
        },
        {
          "workspaceName": "string",
          "workspaceId": 386,
          "permissions": {
            "viewLinkedInSenders": false,
            "manageLinkedInSendersSettings": false,
            "viewLeadLists": false,
            "importEditManageLeadLists": false,
            "viewMyNetwork": false,
            "viewCampaigns": false,
            "editManageCampaigns": false,
            "viewLinkedInSenderInboxes": false,
            "replyFromLinkedInSenderInboxes": false,
            "viewIntegrations": false,
            "manageIntegrations": false,
            "exportDataToCRMs": false,
            "viewNotifications": false,
            "manageNotifications": false
          }
        }
      ]
    },
    {
      "userDetails": {
        "userId": 1372,
        "name": "string",
        "surname": "string",
        "email": "string",
        "roles": [
          "string",
          "string"
        ]
      },
      "userInvitation": {
        "invitationId": 7457,
        "invitationStatus": "Expired",
        "invitationUrl": "string",
        "expirationTime": "1987-09-28T15:34:16Z"
      },
      "organizationPermissions": {
        "userDeactivate": false,
        "manageWorkspace": false,
        "manageWorkspaceMembers": false,
        "viewBilling": false,
        "manageBlling": false,
        "manageBillingDetails": false,
        "accessBillingInvoiceHistoy": false
      },
      "workspacesPermissions": [
        {
          "workspaceName": "string",
          "workspaceId": 5476,
          "permissions": {
            "viewLinkedInSenders": false,
            "manageLinkedInSendersSettings": false,
            "viewLeadLists": false,
            "importEditManageLeadLists": false,
            "viewMyNetwork": false,
            "viewCampaigns": false,
            "editManageCampaigns": false,
            "viewLinkedInSenderInboxes": false,
            "replyFromLinkedInSenderInboxes": false,
            "viewIntegrations": false,
            "manageIntegrations": false,
            "exportDataToCRMs": false,
            "viewNotifications": false,
            "manageNotifications": false
          }
        },
        {
          "workspaceName": "string",
          "workspaceId": 1662,
          "permissions": {
            "viewLinkedInSenders": false,
            "manageLinkedInSendersSettings": false,
            "viewLeadLists": false,
            "importEditManageLeadLists": false,
            "viewMyNetwork": false,
            "viewCampaigns": false,
            "editManageCampaigns": false,
            "viewLinkedInSenderInboxes": false,
            "replyFromLinkedInSenderInboxes": false,
            "viewIntegrations": false,
            "manageIntegrations": false,
            "exportDataToCRMs": false,
            "viewNotifications": false,
            "manageNotifications": false
          }
        }
      ]
    }
  ]
}

Get all existing and invited users in your organization. Filter by role and invitation status.

Request

This endpoint expects an object.

offsetintegerRequired

rolestringRequired

invitationStatuslist of stringsRequired

limitintegerRequired

Response

totalCountinteger

itemslist of objects

Errors

400

Get All Users Workspace Users Request Bad Request Error

401

Get All Users Workspace Users Request Unauthorized Error

429

Get All Users Workspace Users Request Too Many Requests Error

500

Get All Users Workspace Users Request Internal Server Error

Headers

Request

Response

Errors