ProjectsList the contracts of a project

List the contracts of a project

Lists one page of a project's contracts, newest first.

Returns every contract of the project (all statuses and models, system contracts included) as one page of ContractRead, ordered by ContractID descending. projectID is required; omitting it gives a 404 "No action was found" (captured). The project is not checked: an unknown projectID returns an empty page, not an error.

Use it to:

  • Pick the ProjectSubContractID for a payment, expense or mileage registration
  • Find the main contract (IsMainContract) or the default expense contract (IsDefaultExpenses) of a project
  • Reconcile after a create-*-contract call whose response was lost (the newest contract is first)

Not for:

  • Budgets / amounts of a contract — not in ContractRead

Behaviour:

  • Idempotent.
  • Safe to retry.
  • Changes are visible to the next read immediately.

Call first: GET /v1/project/get-all

Next: GET /v1/contract/{contractID}, GET /v1/payment, POST /v1/payment

See also: GET /v1/ContractModel

Not yet documented: examples; request → query params.

curl -X GET "https://app3.timelog.com/your-account/api/v1/contract?projectID=123&$page=1&$pagesize=10" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "Properties": {
    "TotalRecord": "example_string",
    "TotalPage": "example_string",
    "PageNumber": "example_string"
  },
  "Entities": [
    {
      "Properties": {
        "ContractID": 123,
        "ContractGuid": "123e4567-e89b-12d3-a456-426614174000",
        "ContractModelType": 42,
        "ProjectID": 123,
        "IsMainContract": true,
        "ContractName": "John Doe",
        "ContractStatus": 42,
        "IsMileageBillable": true,
        "IsDefaultExpenses": "null",
        "ContractTypeID": 123,
        "ContractTypeName": "John Doe"
      },
      "Links": [
        {
          "Href": "example_string",
          "Rel": "example_string"
        }
      ],
      "Actions": [
        {}
      ]
    }
  ],
  "Links": [
    {
      "Href": "example_string",
      "Rel": "example_string"
    }
  ]
}
GET
/v1/contract
GET
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

OAuth 2.0 bearer token, sent as Authorization: Bearer <token>. JWT and reference tokens are both accepted. The token must carry the required scope (default tlp). The token's sub claim is the acting user. A token WITHOUT sub (client-credentials) acts as the system service user. If the sub user cannot log in (inactive, locked, deleted), the request is rejected with 401 — it is no longer let through without a user. > Not yet documented: how to obtain a token. > Not yet documented: token lifetime.

OAuth 2.0 bearer token, sent as Authorization: Bearer <token>. JWT and reference tokens are both accepted. The token must carry the required scope (default tlp). The token's sub claim is the acting user. A token WITHOUT sub (client-credentials) acts as the system service user. If the sub user cannot log in (inactive, locked, deleted), the request is rejected with 401 — it is no longer let through without a user. > Not yet documented: how to obtain a token. > Not yet documented: token lifetime.
query
projectIDinteger
Required

The project. Required: omitted → 404 rest.action-not-matched. Not validated: an unknown ID gives an empty page. Filters on ContractRead.ProjectID (eq).

Format: int32
query
$pageinteger

Page number.

query
$pagesizeinteger

Page size. No maximum in the API layer.

Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. OAuth 2.0 bearer token, sent as Authorization: Bearer <token>. JWT and reference tokens are both accepted. The token must carry the required scope (default tlp).

The token's sub claim is the acting user. A token WITHOUT sub (client-credentials) acts as the system service user. If the sub user cannot log in (inactive, locked, deleted), the request is rejected with 401 — it is no longer let through without a user.

Not yet documented: how to obtain a token.

Not yet documented: token lifetime.

Query Parameters

projectIDinteger
Required

The project. Required: omitted → 404 rest.action-not-matched. Not validated: an unknown ID gives an empty page.

Filters on ContractRead.ProjectID (eq).

$pageinteger

Page number.

$pagesizeinteger

Page size. No maximum in the API layer.

Responses

Propertiesobject

Paging values. They are returned as STRINGS, for example "TotalRecord": "12".

Entitiesarray

Omitted (not []) when the list is empty.

Linksarray