Sign in

v1

latestOpenAPI 3.0.32026-08-068925782.3 MB
Helpdesk

Lists Helpdesk Case objects available in the collection. If the case has been created not about a particular product -- the "product" section of the response will not be returned.

get/helpdesk/cases

Query parameters

limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

descriptionstring

Filter for: description

lookups: eq, ne, like, ilike, in, out

search: true

events.closed.atstring date-time

Filter for: events.closed.at

lookups: eq, ne, ge, gt, le, lt, null, in, out

ordering: true

events.closed.by.idstring

Filter for: events.closed.by.id

lookups: eq, ne, like, ilike, null, in, out

ordering: true

default: hidden

events.closed.by.namestring

Filter for: events.closed.by.name

lookups: eq, ne, like, ilike, null, in, out

ordering: true

default: hidden

events.created.atstring date-time

Filter for: events.created.at

lookups: eq, ne, ge, gt, le, lt, in, out

ordering: true

events.created.by.idstring

Filter for: events.created.by.id

lookups: eq, ne, like, ilike, in, out

ordering: true

default: hidden

events.created.by.namestring

Filter for: events.created.by.name

lookups: eq, ne, like, ilike, in, out

ordering: true

default: hidden

events.inquiring.atstring date-time

Filter for: events.inquiring.at

lookups: eq, ne, ge, gt, le, lt, null, in, out

ordering: true

events.inquiring.by.idstring

Filter for: events.inquiring.by.id

lookups: eq, ne, like, ilike, null, in, out

ordering: true

default: hidden

events.inquiring.by.namestring

Filter for: events.inquiring.by.name

lookups: eq, ne, like, ilike, null, in, out

ordering: true

default: hidden

events.pending.atstring date-time

Filter for: events.pending.at

lookups: eq, ne, ge, gt, le, lt, null, in, out

ordering: true

events.pending.by.idstring

Filter for: events.pending.by.id

lookups: eq, ne, like, ilike, null, in, out

ordering: true

default: hidden

events.pending.by.namestring

Filter for: events.pending.by.name

lookups: eq, ne, like, ilike, null, in, out

ordering: true

default: hidden

events.resolved.atstring date-time

Filter for: events.resolved.at

lookups: eq, ne, ge, gt, le, lt, null, in, out

ordering: true

events.resolved.by.idstring

Filter for: events.resolved.by.id

lookups: eq, ne, like, ilike, null, in, out

ordering: true

default: hidden

events.resolved.by.namestring

Filter for: events.resolved.by.name

lookups: eq, ne, like, ilike, null, in, out

ordering: true

default: hidden

events.updated.atstring date-time

Filter for: events.updated.at

lookups: eq, ne, ge, gt, le, lt, in, out

ordering: true

events.updated.by.idstring

Filter for: events.updated.by.id

lookups: eq, ne, like, ilike, in, out

ordering: true

default: hidden

events.updated.by.namestring

Filter for: events.updated.by.name

lookups: eq, ne, like, ilike, in, out

ordering: true

default: hidden

idstring

Filter for: id

lookups: eq, ne, like, ilike, null, in, out

issuer.account.idstring

Filter for: issuer.account.id

lookups: eq, ne, like, ilike, null, in, out

ordering: true

issuer.account.namestring

Filter for: issuer.account.name

lookups: eq, ne, like, ilike, in, out

ordering: true

issuer.agent.idstring

Filter for: issuer.agent.id

lookups: eq, ne, like, ilike, null, in, out

ordering: true

issuer.agent.namestring

Filter for: issuer.agent.name

lookups: eq, ne, like, ilike, null, in, out

ordering: true

priority0 | 1 | 2 | 3

Filter for: priority

lookups: eq, ne, ge, gt, le, lt, in, out

ordering: true

receiver.account.idstring

Filter for: receiver.account.id

lookups: eq, ne, like, ilike, null, in, out

ordering: true

receiver.account.namestring

Filter for: receiver.account.name

lookups: eq, ne, like, ilike, in, out

ordering: true

receiver.agent.idstring

Filter for: receiver.agent.id

lookups: eq, ne, like, ilike, null, in, out

ordering: true

receiver.agent.namestring

Filter for: receiver.agent.name

lookups: eq, ne, like, ilike, null, in, out

ordering: true

state'pending' | 'inquiring' | 'resolved' | 'closed'

Filter for: state

lookups: eq, ne, like, ilike, in, out

ordering: true

subjectstring

Filter for: subject

lookups: eq, ne, like, ilike, in, out

search: true

ordering: true

type'technical' | 'business'

Filter for: type

lookups: eq, ne, like, ilike, in, out

ordering: true

Response

idstring
subjectstring required
descriptionstring required
prioritystring
state'pending' | 'inquiring' | 'resolved' | 'closed'
type'technical' | 'business' required
ratingstring nullable
feedbackstring nullable