Skip to content
TradeOps Docs

Get a checklist

GET
/{currentTeam}/audit-types/{auditType}
curl --request GET \
  --url https://api.tradeops.cc/v1/example/audit-types/1 \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
currentTeam
required
string

The current team slug

auditType
required
integer

The audit type ID

Query Parameters

Section titled “Query Parameters”
include
Array<string>
Allowed values: fields fields.auditType fields.auditType.fields fields.auditType.fields.auditType fields.auditType.fields.auditType.fields
fields[audit_types]
Array<string>
Allowed values: name slug description icon color status settings created_at updated_at
fields[fields]
Array<string>
Allowed values: name label type section options validation order required score_weight conditional

Responses

Section titled “Responses”

200

Section titled “200”

AuditTypeResource

Media typeapplication/vnd.api+json
object
data
required
AuditTypeResource
object
id
required
string
type
required
string
Allowed value: audit_types
attributes
object
name
string
slug
string
description
string | null
icon
string | null
color
string | null
status
string
settings
object
created_at
string | null format: date-time
updated_at
string | null format: date-time
relationships
object
fields
object
data
required
Array<object>
object
id
required
string
type
required
string
Allowed value: fields
links
required
object
self
required
string
included
Array
Any of:
FieldResource
object
id
required
string
type
required
string
Allowed value: fields
attributes
object
name
string
label
string
type
string
section
string | null
options
object
validation
object
order
integer
required
boolean
score_weight
string
conditional
object | null
relationships
object
auditType
object
data
required
object
id
required
string
type
required
string
Allowed value: audit_types

Example 

{
  "data": {
    "type": "audit_types",
    "relationships": {
      "fields": {
        "data": [
          {
            "type": "fields"
          }
        ]
      }
    }
  },
  "included": [
    {
      "type": "fields",
      "relationships": {
        "auditType": {
          "data": {
            "type": "audit_types"
          }
        }
      }
    }
  ]
}

401

Section titled “401”

Unauthenticated

Media typeapplication/json
object
message
required

Error overview.

string

Example generated

{
  "message": "example"
}

403

Section titled “403”

Authorization error

Media typeapplication/json
object
message
required

Error overview.

string

Example generated

{
  "message": "example"
}

404

Section titled “404”

Not found

Media typeapplication/json
object
message
required

Error overview.

string

Example generated

{
  "message": "example"
}

429

Section titled “429”

Too many requests. Wait for Retry-After seconds before trying again.

Media typeapplication/json
object
message
required
string

Example generated

{
  "message": "example"
}

Headers

Section titled “Headers”
Retry-After
integer

Seconds until you can try again.