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"
import requests
import json
url = "https://app3.timelog.com/your-account/api/v1/customerstatus?$page=1&$pagesize=10"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())
const response = await fetch("https://app3.timelog.com/your-account/api/v1/customerstatus?$page=1&$pagesize=10", {
method: "GET",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
}
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
)
func main() {
req, err := http.NewRequest("GET", "https://app3.timelog.com/your-account/api/v1/customerstatus?$page=1&$pagesize=10", nil)
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://app3.timelog.com/your-account/api/v1/customerstatus?$page=1&$pagesize=10')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
response = http.request(request)
puts response.body
{
"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"
}
]
}
{
"error": "Unauthorized",
"message": "Authentication required. Please provide a valid API token",
"code": 401
}
{
"error": "Internal Server Error",
"message": "An unexpected error occurred on the server",
"code": 500,
"requestId": "req_1234567890"
}
/v1/customerstatus
Target server for requests. Edit to use your own host.
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.
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.Page number.
Page size. No maximum enforced in the API layer.
Request Preview
Response
Response will appear here after sending the request
Authentication
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
Page number.
Page size. No maximum enforced in the API layer.
Responses
Paging values. They are returned as STRINGS, for example "TotalRecord": "12".
Omitted (not []) when the list is empty.