top of page

Visit Types

API endpoint to get information about Visit Type entities ​

Retrieve Visit Types data 


Supported Protocol: HTTPS

GET /api/:version_number/:project_name/visitTypes

curl -K -H "Authorization: Auth-Token YOUR_PROJECT-API-KEY"

visit_type_uid string

Trax visit type uuid​

display_name string

Name of the visit type

Request Details

Mandatory fields marked indicated by





    "display_name": "visit_type_default_name"




    "display_name": "Monthly"




Response Details

The Visit Types GET reply body will contain an array of objects with the following fields:

Validation and Errors

The following are the validations and errors that may appear due to an invalid GET request:

Incorrect or expired token

  • Error Code: 401 - Unauthorized

  • Error: Incorrect or expired token 

Requesting a forbidden resource

  • Error Code: 403 - Forbidden

  • Error: A forbidden resource has been requested <resource>

Request Headers

Authorization string

Value: 'Auth-Token {project auth token}'

Authentication token provided by Trax

Query Parameters

version_number string *

The current implemented API version. <Major> version (e.g. 'v4')


project_name string *

Project name as provided by Trax

bottom of page