CustomersList customer statuses

List customer statuses

Lists the account's customer statuses, by name.

The value set for CustomerStatusID on customers. Active and inactive statuses are both returned. The system status of the "Multi customer project" pseudo-customer (type 16) is left out. CustomerStatusType tells which group a status belongs to (customer, supplier, lead).

Use it to:

  • Map CRM lifecycle stages (prospect, customer, supplier) to TimeLog statuses before creating customers

Behaviour:

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

Next: POST /v1/customer/create, PUT /v1/customer/update

curl -X GET "https://app3.timelog.com/your-account/api/v1/customerstatus?$page=1&$pagesize=10" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "Properties": {
    "TotalRecord": "4",
    "TotalPage": "1",
    "PageNumber": "1"
  },
  "Entities": [
    {
      "Properties": {
        "CustomerStatusID": 166,
        "ID": "103f9390-afa3-4d61-9a6b-d69be5ce136b",
        "Name": "Customer",
        "IsDefault": true,
        "IsActive": true,
        "CustomerStatusType": 1
      }
    },
    {
      "Properties": {
        "CustomerStatusID": 169,
        "ID": "30953a99-6617-4550-9f80-c5115bc703c7",
        "Name": "Import",
        "IsDefault": false,
        "IsActive": true,
        "CustomerStatusType": 0
      }
    },
    {
      "Properties": {
        "CustomerStatusID": 168,
        "ID": "82c16316-96fc-4dcd-b43d-429e36baee97",
        "Name": "Partner",
        "IsDefault": false,
        "IsActive": true,
        "CustomerStatusType": 3
      }
    },
    {
      "Properties": {
        "CustomerStatusID": 167,
        "ID": "30c24e97-6c4f-44da-8406-4a6815ea93e6",
        "Name": "Supplier",
        "IsDefault": false,
        "IsActive": true,
        "CustomerStatusType": 2
      }
    }
  ],
  "Links": [
    {
      "Href": "https://app{server-number}.timelog.com/{account}/api/v1/customerstatus",
      "Rel": "self"
    }
  ]
}
GET
/v1/customerstatus
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
$pageinteger

Page number.

query
$pagesizeinteger

Page size. No maximum enforced 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

$pageinteger

Page number.

$pagesizeinteger

Page size. No maximum enforced 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