Point types

Available methods

All available methods for resource point types

HTTP method Endpoint Description
[badge-blue GET] /point-types Get information about all point types
[badge-blue GET] /point-types/{point_id} Get information about a point type

Get all point types

Get a list of all point types
[badge-blue GET] /point-types

Query string

Parameter name Type Description Mandatory (Yes/No)
count integer The number of records to return.
Default value is 100.
offset integer The number of records from a collection to skip.
Default value is 0.
sort_field string One of the query string parameters for sorting.
Response is sorted by the specified field.
sort_direction string Direction of sorting the response list.
Possible values are: ASC / DESC


Status code: 200 OK
Output structure : object

Parameter name Type Description
point_types PointType[] List of the point types
total_items integer Count of all found point types

Get a point type

Get information about a specific point type
[badge-blue GET] /point-types/{point_type_id}

Path parameters

Parameter name Type Description
point_type_id string The unique id for the point type


Status code: 200 OK
Output structure : PointType