Sign in
Project Trails

Get a project Trail by ID or project-local number

get/api/v1/{forge}/{project}/trails/{trailId}

Path parameters

forge'gh' | 'et' required
projectstring required
trailIdstring required

Response

Trail

continuationTokenstring
idstring required
projectIdstring required
numberinteger required
titlestring required
bodystring required
status'draft' | 'open' | 'closed' required
phase'planning' | 'building' | 'complete' | 'closed' required
metadataobject required
type'bug' | 'feature' | 'task' required
priority'urgent' | 'high' | 'medium' | 'low' | 'none' required
assigneesstring[] required
assigneeAccountIdsstring[] required
repoIdsstring[] required
authorAccountIdstring required
createdAtstring required
updatedAtstring required
closedAtstring nullable required
isPossiblyPartialboolean

Changes

Changed in 6 of the 29 revisions of this API.2110

  • ba1409f8f36b2See the full diff
    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

  • 03a8a4babd7d1See the full diff
    • ○

      added the required property to the response with the status

      response-required-property-added

  • ae1a9a0cd5421See the full diff
    • ●

      changed the pattern of the path request parameter trailId from ^[0-7][0-9A-HJKMNP-TV-Z]{25}$ to ^([0-7][0-9A-HJKMNP-TV-Z]{25}|[1-9][0-9]{0,9})$

      request-parameter-pattern-changed

  • e1f0e2f14d0a3See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • f15a377013f622See the full diff
    • ▲

      removed the required property // from the response with the status

      response-required-property-removed

    • ▲

      removed the required property / from the response with the status

      response-required-property-removed

    • ○

      added the required property // to the response with the status

      response-required-property-added

    • ○

      added the required property / to the response with the status

      response-required-property-added

  • 7f67a7944a3d2See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added