help

GET

https://api.fleettrack.com

/help/api/v1/articles/

query Parameters

page

integer

A page number within the paginated result set.

page_size

integer

Number of results to return per page.

search

string

A search term.

Responses

200

PaginatedHelpArticleListList

count

integer

next

string | null · uri

previous

string | null · uri

HelpArticleList[]

GET

https://api.fleettrack.com

/help/api/v1/articles/{slug}/

path Parameters

slug

string · required

Responses

200

HelpArticle

id

integer · readOnly · required

object · readOnly · required

title

string · maxLength: 255 · required

route

string · maxLength: 255 · required

created_at

string · date-time · readOnly · required

updated_at

string · date-time · readOnly · required

description

string | null

icon_url

string · uri

slug

string · maxLength: 255 · pattern: ^[-a-zA-Z0-9_]+$

workflow

string | null · maxLength: 100

object

sequence

integer · int64 · min: 0 · max: 4294967295

context_key

string | null · maxLength: 100

account_id

string | null · uuid

is_global

boolean

GET/help/api/v1/articles/{slug}/

curl https://api.fleettrack.com/help/api/v1/articles/:slug

Example Responses

{
  "id": 0,
  "help_article_video": {
    "id": 0,
    "created_at": "2024-08-25T15:00:00Z",
    "updated_at": "2024-08-25T15:00:00Z",
    "title": "title",
    "video": "https://www.example.com/path/to/resource",
    "thumbnail": "https://www.example.com/path/to/resource",
    "description": "description",
    "video_chapters": {
      "key": {}
    },
    "duration": "15:00:00"
  },
  "title": "title",
  "description": "description",
  "icon_url": "https://www.example.com/path/to/resource",
  "slug": "slug",
  "workflow": "workflow",
  "short_steps": {
    "key": {}
  },
  "steps": {
    "key": {}
  },
  "route": "route",
  "sequence": 0,
  "context_key": "context_key",
  "account_id": "00000000-0000-0000-0000-000000000000",
  "is_global": true,
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

GET

https://api.fleettrack.com

/help/api/v1/articles/by-route/

Responses

200

HelpArticle

id

integer · readOnly · required

object · readOnly · required

title

string · maxLength: 255 · required

route

string · maxLength: 255 · required

created_at

string · date-time · readOnly · required

updated_at

string · date-time · readOnly · required

description

string | null

icon_url

string · uri

slug

string · maxLength: 255 · pattern: ^[-a-zA-Z0-9_]+$

workflow

string | null · maxLength: 100

object

sequence

integer · int64 · min: 0 · max: 4294967295

context_key

string | null · maxLength: 100

account_id

string | null · uuid

is_global

boolean

GET/help/api/v1/articles/by-route/

curl https://api.fleettrack.com/help/api/v1/articles/by-route

Example Responses

{
  "id": 0,
  "help_article_video": {
    "id": 0,
    "created_at": "2024-08-25T15:00:00Z",
    "updated_at": "2024-08-25T15:00:00Z",
    "title": "title",
    "video": "https://www.example.com/path/to/resource",
    "thumbnail": "https://www.example.com/path/to/resource",
    "description": "description",
    "video_chapters": {
      "key": {}
    },
    "duration": "15:00:00"
  },
  "title": "title",
  "description": "description",
  "icon_url": "https://www.example.com/path/to/resource",
  "slug": "slug",
  "workflow": "workflow",
  "short_steps": {
    "key": {}
  },
  "steps": {
    "key": {}
  },
  "route": "route",
  "sequence": 0,
  "context_key": "context_key",
  "account_id": "00000000-0000-0000-0000-000000000000",
  "is_global": true,
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

GET

https://api.fleettrack.com

/help/api/v1/contact-number/

query Parameters

ordering

string

Which field to use when ordering the results.

page

integer

A page number within the paginated result set.

page_size

integer

Number of results to return per page.

search

string

A search term.

Responses

200

PaginatedContactNumberList

count

integer

next

string | null · uri

previous

string | null · uri

ContactNumber[]

GET

https://api.fleettrack.com

/help/api/v1/contact-number/{id}/

path Parameters

id

string · required

Responses

200

ContactNumber

id

integer · readOnly · required

created_at

string · date-time · readOnly · required

updated_at

string · date-time · readOnly · required

account_id

string · maxLength: 50 · required

number

string · maxLength: 50 · required

POST

https://api.fleettrack.com

/help/api/v1/contact-us/

Request Body

ContactUs

id

integer · readOnly · required

created_at

string · date-time · readOnly · required

updated_at

string · date-time · readOnly · required

name

string · maxLength: 255 · required

email

string · email · maxLength: 254 · required

message

string · required

phone

string · maxLength: 50

Responses

ContactUs

id

integer · readOnly · required

created_at

string · date-time · readOnly · required

updated_at

string · date-time · readOnly · required

name

string · maxLength: 255 · required

email

string · email · maxLength: 254 · required

message

string · required

phone

string · maxLength: 50

POST/help/api/v1/contact-us/

curl https://api.fleettrack.com/help/api/v1/contact-us \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 0,
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z",
  "name": "name",
  "email": "[email protected]",
  "phone": "phone",
  "message": "message"
}'

Example Request Body

{
  "id": 0,
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z",
  "name": "name",
  "email": "[email protected]",
  "phone": "phone",
  "message": "message"
}

json

Example Responses

{
  "id": 0,
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z",
  "name": "name",
  "email": "[email protected]",
  "phone": "phone",
  "message": "message"
}

json

application/json

GET

https://api.fleettrack.com

/help/api/v1/faq/

query Parameters

category

integer

category__name

string

ordering

string

Which field to use when ordering the results.

page

integer

A page number within the paginated result set.

page_size

integer

Number of results to return per page.

search

string

A search term.

Responses

200

PaginatedFaqList

count

integer

next

string | null · uri

previous

string | null · uri

Faq[]

GET

https://api.fleettrack.com

/help/api/v1/faq-category/

ordering

string

Which field to use when ordering the results.

page

integer

A page number within the paginated result set.

page_size

integer

Number of results to return per page.

search

string

A search term.

200

PaginatedFaqCategoryList

count

integer

next

string | null · uri

previous

string | null · uri

FaqCategory[]

GET

https://api.fleettrack.com

/help/api/v1/faq-category/{id}/

path Parameters

id

string · required

Responses

200

FaqCategory

id

integer · readOnly · required

created_at

string · date-time · readOnly · required

updated_at

string · date-time · readOnly · required

account_id

string · maxLength: 50 · required

name

string · maxLength: 255 · required

sequence

integer · int64 · min: 0 · max: 4294967295

GET

https://api.fleettrack.com

/help/api/v1/faq/{id}/

path Parameters

id

integer · required

A unique integer value identifying this faq.

Responses

200

Faq

id

integer · readOnly · required

created_at

string · date-time · readOnly · required

updated_at

string · date-time · readOnly · required

question

string · required

answer

string · required

category

integer · required

sequence

integer · int64 · min: 0 · max: 4294967295

document legacy