Task Type

From docs
Jump to: navigation, search

Mobile_API »Get Task Types

Base URL

https://apimobile.callproof.com

Endpoint

/api/task-type

Purpose

Retrieves the list of task types configured for the authenticated user’s company, ordered by position.

HTTP Method

GET

Headers

Header Required Description
Authorization Yes Bearer access token

Security

  • Yes – Requires Bearer Token authentication.

Parameters

Path Parameters

None.

Query Parameters

None.

Request Body

None.

cURL Example for Android

 curl --location 'https://apimobile.callproof.com/api/task-type' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' 

cURL Example for iOS

 curl --location 'https://apimobile.callproof.com/api/task-type' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' 

Successful Response (200)

Returns the company’s task types.

Field Type Description
clientStatusCode integer Status indicator for the client (for example, 200)
user_id integer Identifier of the authenticated user
company_id integer Identifier of the authenticated user’s company
data object Task type payload
uri string Requested resource URI

data.task-type[]

Field Type Description
task_id integer Unique identifier of the task type
task_name string Display name of the task type
position integer Display/sort order
is_default boolean Whether this is the default task type

Error Responses

Status Code Meaning
400 Bad Request – task types could not be retrieved
401 Unauthorized – missing, invalid, or expired Bearer token
  • 400 – An error occurred while loading task types.
  • 401 – Authentication failed or the access token is missing/expired.