GetWorkspaceUsers | HeyReach API Documentation

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

{
  "totalCount": 1040,
  "items": [
    {
      "workspaceId": 9178,
      "organizationPermissions": {
        "userDeactivate": false,
        "manageWorkspace": false,
        "manageWorkspaceMembers": false,
        "viewBilling": false,
        "manageBlling": false,
        "manageBillingDetails": false,
        "accessBillingInvoiceHistoy": false
      },
      "workspacePermissions": {
        "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": 5497,
        "name": "string",
        "surname": "string",
        "email": "string",
        "roles": [
          "string",
          "string"
        ]
      },
      "userInvitation": {
        "invitationId": 1916,
        "invitationStatus": "Accepted",
        "invitationUrl": "string",
        "expirationTime": "2011-01-09T19:33:34Z"
      }
    },
    {
      "workspaceId": 7874,
      "organizationPermissions": {
        "userDeactivate": false,
        "manageWorkspace": false,
        "manageWorkspaceMembers": false,
        "viewBilling": false,
        "manageBlling": false,
        "manageBillingDetails": false,
        "accessBillingInvoiceHistoy": false
      },
      "workspacePermissions": {
        "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": 8221,
        "name": "string",
        "surname": "string",
        "email": "string",
        "roles": [
          "string",
          "string"
        ]
      },
      "userInvitation": {
        "invitationId": 5704,
        "invitationStatus": "Pending",
        "invitationUrl": "string",
        "expirationTime": "2006-06-07T07:59:17Z"
      }
    }
  ]
}

Get all users in a given workspace along with their role and permissions.

Path parameters

workspaceIdstringRequired

Request

This endpoint expects an object.

offsetintegerRequired

rolestringRequired

invitationStatuslist of stringsRequired

limitintegerRequired

Response

totalCountinteger

itemslist of objects

Errors

400

Get Workspace Users Workspace Users Request Bad Request Error

401

Get Workspace Users Workspace Users Request Unauthorized Error

429

Get Workspace Users Workspace Users Request Too Many Requests Error

500

Get Workspace Users Workspace Users Request Internal Server Error

Path parameters

Headers

Request

Response

Errors