Get activity codes

Returns a list of activity codes.

GET /activitycodes

Get activity codes

cURL

curl --request GET \
  --url https://api.smokeball.com/activitycodes \
  --header 'Authorization: <api-key>' \
  --header 'x-api-key: <api-key>'

200

{
  "id": "<string>",
  "href": "<string>",
  "relation": "<string>",
  "method": "GET",
  "self": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "value": [
    {
      "href": "<string>",
      "relation": "<string>",
      "method": "GET",
      "self": {
        "id": "<string>",
        "href": "<string>",
        "relation": "<string>",
        "method": "GET"
      },
      "id": "23d2a4bc-8529-462e-8560-dfbf4fa24e49",
      "versionId": "23d2a4bc-8529-462e-8560-dfbf4fa24e49",
      "updatedByUserId": "750eb5c5-ac0b-7d11-4997-e0ce9d8896c8",
      "type": 0,
      "description": "Contract review",
      "code": "CR",
      "isBillable": true,
      "rateType": 2,
      "rate": 23.2,
      "quantity": 0.6,
      "taxInclusive": true,
      "taxExempt": true,
      "taxZeroRated": false,
      "taxOutOfScope": false,
      "isDeleted": true
    }
  ],
  "offset": 123,
  "limit": 123,
  "size": 123,
  "first": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "previous": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "next": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "last": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  }
}

Authorizations

x-api-key · string · header · required

Authorization · string · header · required

Query Parameters

Offset · integer<int32>

Required range: 0 <= x <= 2147483647

Limit · integer<int32>

Required range: 1 <= x <= 500

UpdatedSince · integer<int64>

Returns expenses updated since a specified time (.net ticks representation of the UTC datetime).

Response

200

application/json

When request is successful. Returns a paged collection of 'ActivityCode' objects.

id · string | null

href · string | null

relation · string | null

method · string | null · default: GET

self · object

Show child attributes

value · object[] | null

Show child attributes

offset · integer<int32> | null

limit · integer<int32> | null

size · integer<int64>

first · object

Show child attributes

previous · object

Show child attributes

next · object

Show child attributes

last · object

Show child attributes