GET v1/Activities

Retrieve activity journal entries for current (api) user.

Request Information

Requires Authorization!

URI Parameters

NameDescriptionTypeAdditional information
fromDate

Limit search to entries after or equal provided Date(Time). When not supplied, 'Today' is used

date

Is Optional.

Default value is (null).

tillDate

Limit search to entries before provided Date(Time)

date

Is Optional.

Default value is (null).

changedSince

date

Is Optional.

Default value is (null).

shopId

Limit search to entries for a specific shop

integer

Is Optional.

Default value is (null).

pageSize

The max number of items returned. Default this value is 40.

integer

Is Optional.

Default value is 40.

pageNumber

The page to return. Default page 1 will be returned.

integer

Is Optional.

Default value is 1.

Body Parameters

None.

Response Information

Resource Description

List of activity journal entries


Collection of ActivityJournalEntry
NameDescriptionTypeAdditional information
Id

integer

None.

Category

ActivityJournalCategory

None.

Employee

EmployeeBasicInfo

None.

Shop

ShopBasicInfo

None.

Customer

CustomerBasicInfo

None.

Hours

decimal number

None.

Date

date

None.

Subject

string

None.

Comment

string

None.

Billable

boolean

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Id": 1,
    "Category": {
      "Id": 1,
      "ShopOwnerId": 1,
      "Name": "sample string 2"
    },
    "Employee": {
      "Id": 1,
      "FullName": "sample string 2",
      "Login": "sample string 3",
      "Enabled": true,
      "ShopOwnerId": 1,
      "ShopOwnerCompanyName": "sample string 5",
      "IsAdmin": true,
      "IsShopOwnerAdmin": true,
      "LastLogin": "2021-12-02T20:19:31.7947307+01:00",
      "PhoneExtension": "sample string 8",
      "CultureId": 1,
      "CultureCode": "sample string 9"
    },
    "Shop": {
      "Id": 1,
      "Name": "sample string 2",
      "ShopOwnerId": 3,
      "ShopGroupId": 4,
      "Active": true
    },
    "Customer": null,
    "Hours": 2.0,
    "Date": "2021-12-02T20:19:31.7947307+01:00",
    "Subject": "sample string 4",
    "Comment": "sample string 5",
    "Billable": true
  },
  {
    "Id": 1,
    "Category": {
      "Id": 1,
      "ShopOwnerId": 1,
      "Name": "sample string 2"
    },
    "Employee": {
      "Id": 1,
      "FullName": "sample string 2",
      "Login": "sample string 3",
      "Enabled": true,
      "ShopOwnerId": 1,
      "ShopOwnerCompanyName": "sample string 5",
      "IsAdmin": true,
      "IsShopOwnerAdmin": true,
      "LastLogin": "2021-12-02T20:19:31.7947307+01:00",
      "PhoneExtension": "sample string 8",
      "CultureId": 1,
      "CultureCode": "sample string 9"
    },
    "Shop": {
      "Id": 1,
      "Name": "sample string 2",
      "ShopOwnerId": 3,
      "ShopGroupId": 4,
      "Active": true
    },
    "Customer": null,
    "Hours": 2.0,
    "Date": "2021-12-02T20:19:31.7947307+01:00",
    "Subject": "sample string 4",
    "Comment": "sample string 5",
    "Billable": true
  }
]

application/xml, text/xml

Sample:
<ArrayOfActivityJournalEntry xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ActivityJournalEntry>
    <Id>1</Id>
    <Category>
      <Id>1</Id>
      <ShopOwnerId>1</ShopOwnerId>
      <Name>sample string 2</Name>
    </Category>
    <Employee>
      <Id>1</Id>
      <FullName>sample string 2</FullName>
      <Login>sample string 3</Login>
      <Enabled>true</Enabled>
      <ShopOwnerId>1</ShopOwnerId>
      <ShopOwnerCompanyName>sample string 5</ShopOwnerCompanyName>
      <IsAdmin>true</IsAdmin>
      <IsShopOwnerAdmin>true</IsShopOwnerAdmin>
      <LastLogin>2021-12-02T20:19:31.7947307+01:00</LastLogin>
      <PhoneExtension>sample string 8</PhoneExtension>
      <CultureId>1</CultureId>
      <CultureCode>sample string 9</CultureCode>
    </Employee>
    <Shop>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <ShopOwnerId>3</ShopOwnerId>
      <ShopGroupId>4</ShopGroupId>
      <Active>true</Active>
    </Shop>
    <Hours>2</Hours>
    <Date>2021-12-02T20:19:31.7947307+01:00</Date>
    <Subject>sample string 4</Subject>
    <Comment>sample string 5</Comment>
    <Billable>true</Billable>
  </ActivityJournalEntry>
  <ActivityJournalEntry>
    <Id>1</Id>
    <Category>
      <Id>1</Id>
      <ShopOwnerId>1</ShopOwnerId>
      <Name>sample string 2</Name>
    </Category>
    <Employee>
      <Id>1</Id>
      <FullName>sample string 2</FullName>
      <Login>sample string 3</Login>
      <Enabled>true</Enabled>
      <ShopOwnerId>1</ShopOwnerId>
      <ShopOwnerCompanyName>sample string 5</ShopOwnerCompanyName>
      <IsAdmin>true</IsAdmin>
      <IsShopOwnerAdmin>true</IsShopOwnerAdmin>
      <LastLogin>2021-12-02T20:19:31.7947307+01:00</LastLogin>
      <PhoneExtension>sample string 8</PhoneExtension>
      <CultureId>1</CultureId>
      <CultureCode>sample string 9</CultureCode>
    </Employee>
    <Shop>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <ShopOwnerId>3</ShopOwnerId>
      <ShopGroupId>4</ShopGroupId>
      <Active>true</Active>
    </Shop>
    <Hours>2</Hours>
    <Date>2021-12-02T20:19:31.7947307+01:00</Date>
    <Subject>sample string 4</Subject>
    <Comment>sample string 5</Comment>
    <Billable>true</Billable>
  </ActivityJournalEntry>
</ArrayOfActivityJournalEntry>