GET v2/entities({CompanyId})/users

Returns All the Users in a Company

Information:

Base URL:

https://api.covasoft.net/usermanager

Example of a call would be:

https://api.covasoft.net/usermanager/v1/entities({CompanyId})/users?$skip=0&$top=100

Odata Filters

Optional: $filter=ClientUserId eq '{ClientUserId}'

Optional: $filter=CorrelationId eq '{CorrelationId}'

Optional: $filter=isactive eq '{IsActive}'

Optional: $filter=userName eq '{term}'

Normal Odata pagings with $top & $skip

Max $top is 100 records

Request Information

URI Parameters

Name	Description	Type	Additional information
CompanyId	The unique Company Id that was provided in your onboarding pacakage	integer	Required

Body Parameters

None.

Response Information

Resource Description

All the Users in a Company

GetAllUsersByCompanyReturn

Name	Type	Additional information
_links	UserLinks	None.
_metadata	UserMetadata	None.
items	Collection of UserItem	None.

Response Formats

application/json, text/json

Sample:

{
  "_links": {
    "prev": "sample string 1",
    "self": "sample string 2",
    "next": "sample string 3"
  },
  "_metadata": {
    "count": 1,
    "skip": 1,
    "top": 1
  },
  "items": [
    {
      "Id": 1,
      "CorrelationId": "sample string 1",
      "ClientUserId": "sample string 2",
      "FirstName": "sample string 3",
      "LastName": "sample string 4",
      "UserName": "sample string 5",
      "Email": "sample string 6",
      "IsActive": true,
      "ParentEntityId": 1,
      "ParentEntityName": "sample string 8",
      "Picture": {
        "Id": "6d5f4b58-4fd3-427b-8bc5-cf2c490801f0",
        "Href": "http://webapihelppage2.com",
        "Height": 1.1,
        "Width": 1.1,
        "Md5Checksum": "sample string 3",
        "Name": "sample string 4",
        "MimeType": "sample string 5"
      },
      "Address": {
        "AddressLine1": "sample string 1",
        "AddressLine2": "sample string 2",
        "City": "sample string 3",
        "StateCode": "sample string 4",
        "CountryCode": "sample string 5",
        "Zip": "sample string 6"
      },
      "PhoneNumbers": [
        {
          "Number": "sample string 1",
          "Extension": "sample string 2",
          "Type": "sample string 3"
        },
        {
          "Number": "sample string 1",
          "Extension": "sample string 2",
          "Type": "sample string 3"
        }
      ],
      "JobTitle": "sample string 9",
      "Attributes": {
        "Department": "sample string 1",
        "BadgeId": 2
      },
      "Version": 10
    },
    {
      "Id": 1,
      "CorrelationId": "sample string 1",
      "ClientUserId": "sample string 2",
      "FirstName": "sample string 3",
      "LastName": "sample string 4",
      "UserName": "sample string 5",
      "Email": "sample string 6",
      "IsActive": true,
      "ParentEntityId": 1,
      "ParentEntityName": "sample string 8",
      "Picture": {
        "Id": "6d5f4b58-4fd3-427b-8bc5-cf2c490801f0",
        "Href": "http://webapihelppage2.com",
        "Height": 1.1,
        "Width": 1.1,
        "Md5Checksum": "sample string 3",
        "Name": "sample string 4",
        "MimeType": "sample string 5"
      },
      "Address": {
        "AddressLine1": "sample string 1",
        "AddressLine2": "sample string 2",
        "City": "sample string 3",
        "StateCode": "sample string 4",
        "CountryCode": "sample string 5",
        "Zip": "sample string 6"
      },
      "PhoneNumbers": [
        {
          "Number": "sample string 1",
          "Extension": "sample string 2",
          "Type": "sample string 3"
        },
        {
          "Number": "sample string 1",
          "Extension": "sample string 2",
          "Type": "sample string 3"
        }
      ],
      "JobTitle": "sample string 9",
      "Attributes": {
        "Department": "sample string 1",
        "BadgeId": 2
      },
      "Version": 10
    }
  ]
}