Ask Moov Beta
Generative AI is experimental and can make mistakes.
Guides Dashboard Use cases API Changelog
  1. API reference
  2. Moov accounts
  3. Connected account support tickets

Retrieve a support ticket

Retrieve a support ticket by ID.

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

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

GET
/accounts/{accountID}/tickets/{ticketID}
cURL Go TypeScript PHP Python Java Ruby (beta) 
1
2

curl -X GET "https://api.moov.io/accounts/{accountID}/tickets/{ticketID}" \
  -H "Authorization: Bearer {token}" \

1
2
3
4
5
6

mc, _ := moov.NewClient()

var accountID string // customer
var ticketID string

mc.GetTicket(ctx, accountID, ticketID)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16

import { SDK } from "openapi";

const sdk = new SDK({
  xMoovVersion: "v2024.01.00",
});

async function run() {
  const result = await sdk.support.getTicket({
    accountID: "873ccb78-88b3-4520-85f2-7cc2aef5704b",
    ticketID: "91fea9bf-b373-40f7-86e0-2c80690126e4",
  });

  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

declare(strict_types=1);

require 'vendor/autoload.php';

use OpenAPI\OpenAPI;

$sdk = OpenAPI\SDK::builder()
    ->setXMoovVersion('v2024.01.00')
    ->build();



$response = $sdk->support->getTicket(
    accountID: '873ccb78-88b3-4520-85f2-7cc2aef5704b',
    ticketID: '91fea9bf-b373-40f7-86e0-2c80690126e4'

);

if ($response->ticket !== null) {
    // handle response
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

from openapi import SDK


with SDK(
    x_moov_version="v2024.01.00",
) as sdk:

    res = sdk.support.get_ticket(account_id="873ccb78-88b3-4520-85f2-7cc2aef5704b", ticket_id="91fea9bf-b373-40f7-86e0-2c80690126e4")

    # Handle response
    print(res)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

package hello.world;

import java.lang.Exception;
import org.openapis.openapi.SDK;
import org.openapis.openapi.models.operations.GetTicketResponse;

public class Application {

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

        SDK sdk = SDK.builder()
                .xMoovVersion("v2024.01.00")
            .build();

        GetTicketResponse res = sdk.support().getTicket()
                .accountID("873ccb78-88b3-4520-85f2-7cc2aef5704b")
                .ticketID("91fea9bf-b373-40f7-86e0-2c80690126e4")
                .call();

        if (res.ticket().isPresent()) {
            // handle response
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

require 'openapi'

Models = ::OpenApiSDK::Models
s = ::OpenApiSDK::SDK.new(
      x_moov_version: 'v2024.01.00',
    )

res = s.support.get_ticket(account_id: '873ccb78-88b3-4520-85f2-7cc2aef5704b', ticket_id: '91fea9bf-b373-40f7-86e0-2c80690126e4')

unless res.ticket.nil?
  # handle response
end
200 401 403 404 429 500 504
The request completed successfully.
application/json
Example
{
  "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",
  "foreignID": "string"
}

Response headers

x-request-id

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

Response headers

x-request-id

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

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The requested resource was not found.

Response headers

x-request-id

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

Response headers

x-request-id

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

Response headers

x-request-id

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

Response headers

x-request-id

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

Headers

X-Moov-Version

string

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

ticketID

string <uuid> required

Response

application/json

contact

object required
Show child attributes

email

string required

name

string

createdOn

string<date-time> required

number

integer required

status

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

ticketID

string required

title

string required

updatedOn

string<date-time> required

closedOn

string<date-time>

foreignID

string

latestMessageOn

string<date-time>