Get Contract State

GET 
https://[AccountName].logeto.com/api/v2/Contracts/States/:key

Get Contract State

Request

Path Parameters

key stringrequired

Guid or ExternalKey

Responses

200

Success

application/json

Schema

Schema

Guid guid
Revision int64
PersonCreated guidnullable
PersonChanged guidnullable
TimestampCreated date-timenullable
Example: 2025-02-24T10:14:00Z
TimestampChanged date-timenullable
Example: 2025-02-24T10:14:00Z
Name stringnullable

Possible values: <= 100 characters

DisplayName stringnullable

Possible values: <= 100 characters

Visibility ContractStateVisibility (string)

Possible values: [Contracts, Subcontracts, All]

Color stringnullable

Possible values: <= 7 characters

SortOrder integer
ExternalKey stringnullable

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",
  "DisplayName": "string",
  "Visibility": "Contracts",
  "Color": "string",
  "SortOrder": 0,
  "ExternalKey": "string"
}

404

Not found

application/json

Schema

Schema

Guid guid
Revision int64
PersonCreated guidnullable
PersonChanged guidnullable
TimestampCreated date-timenullable
Example: 2025-02-24T10:14:00Z
TimestampChanged date-timenullable
Example: 2025-02-24T10:14:00Z
Name stringnullablerequired
Code stringnullable

Type

object

oneOf

ActivityType

string

Possible values: [Work, Absence, Break]

Default boolean

TimeEntry

object

oneOf

ActivityTypeTimeEntry

string

Possible values: [Optional, TotalTime, FromTo]

Inactive boolean
Movement boolean
Icon stringnullable
ExternalKey stringnullable

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"
}

Authorization: AccessKey

name: AccessKeytype: apiKeyin: header

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://[AccountName].logeto.com/api/v2/Contracts/States/:key");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("AccessKey", "<API_KEY_VALUE>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://[AccountName].logeto.com

Auth

AccessKey

Parameters

key — pathrequired

ResponseClear

Click the Send API Request button above and see the response here!