List support tickets

List all the support tickets created under a Moov account.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/tickets.read scope.

If you're listing another account's tickets, then you'll need to specify the /accounts/{partnerAccountID}/tickets.read and /accounts/{accountID}/profile.read scopes.

GET
/accounts/{accountID}/tickets
cURL Python TypeScript Java Ruby (beta) PHP
1
2
curl -X GET "https://api.moov.io/accounts/{accountID}/tickets" \
  -H "Authorization: Bearer {token}" \
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from moovio_sdk import Moov
from moovio_sdk.models import components


with Moov(
    x_moov_version="v2024.01.00",
    security=components.Security(
        username="",
        password="",
    ),
) as moov:

    res = moov.support.list_tickets(account_id="8ef75c13-2a50-4438-b294-2a850eb4986d", count=20)

    # Handle response
    print(res)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
import { Moov } from "@moovio/sdk";

const moov = new Moov({
  xMoovVersion: "v2024.01.00",
  security: {
    username: "",
    password: "",
  },
});

async function run() {
  const result = await moov.support.listTickets({
    count: 20,
    accountID: "8ef75c13-2a50-4438-b294-2a850eb4986d",
  });

  console.log(result);
}

run();
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
package hello.world;

import java.lang.Exception;
import org.openapis.openapi.Moov;
import org.openapis.openapi.models.components.Security;
import org.openapis.openapi.models.operations.ListTicketsResponse;

public class Application {

    public static void main(String[] args) throws Exception {

        Moov sdk = Moov.builder()
                .xMoovVersion("v2024.01.00")
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        ListTicketsResponse res = sdk.support().listTickets()
                .count(20L)
                .accountID("8ef75c13-2a50-4438-b294-2a850eb4986d")
                .call();

        if (res.object().isPresent()) {
            // handle response
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
require 'moov_ruby'

Models = ::Moov::Models
s = ::Moov::Client.new(
      x_moov_version: 'v2024.01.00',
      security: Models::Components::Security.new(
        username: '',
        password: '',
      ),
    )

req = Models::Operations::ListTicketsRequest.new(
  count: 20,
  account_id: '8ef75c13-2a50-4438-b294-2a850eb4986d',
)

res = s.support.list_tickets(request: req)

unless res.object.nil?
  # handle response
end
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
declare(strict_types=1);

require 'vendor/autoload.php';

use Moov\MoovPhp;
use Moov\MoovPhp\Models\Components;
use Moov\MoovPhp\Models\Operations;

$sdk = MoovPhp\Moov::builder()
    ->setXMoovVersion('v2024.01.00')
    ->setSecurity(
        new Components\Security(
            username: '',
            password: '',
        )
    )
    ->build();

$request = new Operations\ListTicketsRequest(
    count: 20,
    accountID: '8ef75c13-2a50-4438-b294-2a850eb4986d',
);

$response = $sdk->support->listTickets(
    request: $request
);

if ($response->object !== null) {
    // handle response
}
200 401 403 429 500 504
The request completed successfully.
application/json
A paginated list of items. The nextPage field is omitted if there are no more pages available.
{
  "items": [
    {
      "ticketID": "string",
      "number": 0,
      "title": "string",
      "contact": {
        "email": "string",
        "name": "string"
      },
      "status": "new",
      "createdOn": "2019-08-24T14:15:22Z",
      "updatedOn": "2019-08-24T14:15:22Z",
      "latestMessageOn": "2019-08-24T14:15:22Z",
      "closedOn": "2019-08-24T14:15:22Z"
    }
  ],
  "nextPage": {
    "cursor": "string"
  }
}

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The request contained missing or expired authentication.

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The user is not authorized to make the request.

x-request-id

string <uuid> required
A unique identifier used to trace requests.
Request was refused due to rate limiting.

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The request failed due to an unexpected error.

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The request failed because a downstream service failed to respond.

x-request-id

string <uuid> required
A unique identifier used to trace requests.

Headers

x-moov-version

string
API version

Specify an API version.

API versioning follows the format vYYYY.QQ.BB, where

  • YYYY is the year
  • QQ is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10)
  • BB is the build number, starting at .01, for subsequent builds in the same quarter.
    • For example, v2024.01.00 is the initial release of the first quarter of 2024.

The latest version represents the most recent development state. It may include breaking changes and should be treated as a beta release.

Default: v2024.01.00

Path parameters

accountID

string <uuid> required

Query parameters

cursor

string

count

integer <int64>
Default: 200

status

string
Possible values: new, in-progress, on-hold, closed

Response

application/json
A paginated list of items. The nextPage field is omitted if there are no more pages available.

items

array required
Show child attributes

closedOn

string<date-time>

contact

object
Show child attributes

email

string required

name

string

createdOn

string<date-time>

latestMessageOn

string<date-time>

number

integer

status

string<enum>
Possible values: new, in-progress, on-hold, closed

ticketID

string

title

string

updatedOn

string<date-time>

nextPage

object
Show child attributes

cursor

string required
The cursor value to use for the next page of items.