Get Event-Type Details

From docs
Jump to: navigation, search

Mobile_API »Get Event Types

Base URL

https://apimobile.callproof.com

Endpoint

/api/event-type

Purpose

Retrieves the list of event types configured for the authenticated user’s company, ordered by name. Each item includes a display-friendly event type name derived from the stored name.

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/event-type' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' 

cURL Example for iOS

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

Successful Response (200)

Returns the company’s event 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 array List of event types
uri string Requested resource URI

data[]

Field Type Description
event_id integer Unique identifier of the event type
event_name string Stored event type name (for example, mobile_login)
event_description string Description of the event type
event_image string Image associated with the event type, when available
event_type_name string Display name derived from event_name (underscores replaced with spaces, words capitalized)

Error Responses

Status Code Meaning
400 Bad Request – event types could not be retrieved
401 Unauthorized – missing, invalid, or expired Bearer token
  • 400 – An error occurred while retrieving event types (for example, "Error while retriving the Events List").
  • 401 – Authentication failed or the access token is missing/expired.