Get Plan Record

GET 
/api/v2/Plan/:key

Get Plan Record

Request

Path Parameters

key stringrequired

Guid or ExternalKey

Responses

200

Success

application/json

Schema

Schema

Guidguid
Revisionint64
PersonCreatedguidnullable
PersonChangedguidnullable
TimestampCreateddate-timenullable
Example: 2025-02-24T10:14:00Z
TimestampChangeddate-timenullable
Example: 2025-02-24T10:14:00Z
CustomFieldsobjectnullable
Personguidrequired
Datedatenullable
Fromdate-timenullable
Todate-timenullable
Hoursdurationnullable
Activityguidrequired
Descriptionstringnullable
Contractguidnullable
Subcontractguidnullable
ExternalKeystringnullable

Example (from schema)

{
  "Guid": "string",
  "Revision": 0,
  "PersonCreated": "string",
  "PersonChanged": "string",
  "TimestampCreated": "2025-02-24T10:14:00Z",
  "TimestampChanged": "2025-02-24T10:14:00Z",
  "CustomFields": {},
  "Person": "string",
  "Date": "2024-07-29",
  "From": "2024-07-29T15:51:28.071Z",
  "To": "2024-07-29T15:51:28.071Z",
  "Hours": "string",
  "Activity": "string",
  "Description": "string",
  "Contract": "string",
  "Subcontract": "string",
  "ExternalKey": "string"
}

404

Not found

application/json

Schema

Schema

Guidguid
Revisionint64
PersonCreatedguidnullable
PersonChangedguidnullable
TimestampCreateddate-timenullable
Example: 2025-02-24T10:14:00Z
TimestampChangeddate-timenullable
Example: 2025-02-24T10:14:00Z
Namestringnullablerequired
Codestringnullable

Type

object

oneOf

ActivityType

string

Possible values: [Work, Absence, Break]

Defaultboolean

TimeEntry

object

oneOf

ActivityTypeTimeEntry

string

Possible values: [Optional, TotalTime, FromTo]

Inactiveboolean
Movementboolean
Iconstringnullable
ExternalKeystringnullable

Example (from schema)

{
  "Guid": "string",
  "Revision": 0,
  "PersonCreated": "string",
  "PersonChanged": "string",
  "TimestampCreated": "2025-02-24T10:14:00Z",
  "TimestampChanged": "2025-02-24T10:14:00Z",
  "Name": "string",
  "Code": "string",
  "Type": "Work",
  "Default": true,
  "TimeEntry": "Optional",
  "Inactive": true,
  "Movement": true,
  "Icon": "string",
  "ExternalKey": "string"
}