retrieve retrieve-by-id Return to API overview

Calls: {root}/{version}/company message


POST/v4/retrieve
Route {root}/v4/company-message/retrieve
Request type BODY
User level STAFF
Requires authentication Yes
Response type Single

Parameters

Name Type Nullable? Required? Min. Max. Nest Custom
start_date DATE REQUIRED - -
end_date DATE REQUIRED - -
map_type_id CUSTOM ✓ OPTIONAL - company (0)
department (1)
tag (2)
staff (3)
region (7)
any (-1)
map_id [INT32] ✓ OPTIONAL 0 2147483647 - -

Sample cURL

curl --location --request POST "{{ROOT}}/v4/company-message/retrieve/" \
-H "Authorization: Bearer {{BEARER_TOKEN}}" \
-H "app-id:{{APP_ID}}" \
-H "Content-Type: application/json" \
-H "Accept-Encoding: gzip" \
-H "accept: */*" \
--data '{"map_type_id": "0","map_id": "123456"}'

Sample response

[
    {
      "object_name":"company_message_id",
      "type":"Int32",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"title",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"start_date",
      "type":"DateTime",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"end_date",
      "type":"DateTime",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"map_type_id",
      "type":"[Byte]",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"total",
      "type":"[Int32]",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  }
]
GET/v4/retrieve-by-id
Route {root}/v4/company-message/retrieve-by-id
Request type URL
User level STAFF
Requires authentication Yes
Response type Single
Sample call{root}/v0/company-message/retrieve-by-id/12345678

Parameters

Name Type Nullable? Required? Min. Max. Nest Custom
company_message_id INT32 REQUIRED 0 2147483647 - -

Sample cURL

curl --location --request GET "{{ROOT}}/v4/company-message/retrieve-by-id/12345678-H "Authorization: Bearer {{BEARER_TOKEN}}" \
-H "app-id:{{APP_ID}}" \
-H "Content-Type: application/json" \
-H "Accept-Encoding: gzip" \
-H "accept: */*" \

Sample response

[
    {
      "object_name":"company_message_id",
      "type":"Int32",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"title",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"message",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"start_date",
      "type":"DateTime",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"end_date",
      "type":"DateTime",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"map_type_id",
      "type":"Byte",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"ids",
      "type":"NESTED",
      "is_nullable":false,
      "nest":[
            {
                "object_name":"id",
                "type":"Int32",
                "is_nullable":False,
                "nest":null,
                "custom":null
                "note":"",
            }],
      "custom":null
      "note": 
  }
]


Don't have a WhosOff account yet?

Instantly reduce time spent on leave management with your FREE, no obligation trial today!
Sign up today and get until Sunday, 26th July 2026 to try the full service, for Free!

Get your instant FREE account today