Skip to content
TradeOps Docs

Get a campaign

GET
/{currentTeam}/campaigns/{campaign}
curl --request GET \
  --url https://api.tradeops.cc/v1/example/campaigns/example \
  --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

campaign
required
string

The campaign ulid

Query Parameters

Section titled “Query Parameters”
include
Array<string>
Allowed values: assignments assignments.auditType assignments.auditType.fields assignments.auditType.fields.auditType assignments.auditType.fields.auditType.fields assignments.customer assignments.customer.locations assignments.submission assignments.submission.auditType assignments.submission.auditType.fields assignments.submission.auditType.fields.auditType assignments.submission.customer assignments.submission.customer.locations
fields[campaigns]
Array<string>
Allowed values: name slug description starts_on ends_on status settings details detail_fields items created_at updated_at
fields[assignments]
Array<string>
Allowed values: status due_date completed_at notes created_at updated_at
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
fields[customers]
Array<string>
Allowed values: name slug number type channel region territory address city parish latitude longitude contact_name contact_phone contact_email metadata is_active created_at updated_at
fields[customer_locations]
Array<string>
Allowed values: name address city state_province latitude longitude contact_name contact_phone contact_email is_primary is_active created_at updated_at
fields[submissions]
Array<string>
Allowed values: data status score max_score latitude longitude submitted_at reviewed_at review_notes created_at updated_at

Responses

Section titled “Responses”

200

Section titled “200”

CampaignResource

Media typeapplication/vnd.api+json
object
data
required
CampaignResource
object
id
required
string
type
required
string
Allowed value: campaigns
attributes
object
name
string
slug
string
description
string | null
starts_on
string | null format: date-time
ends_on
string | null format: date-time
status
string
settings
object
details
object
detail_fields
Array<object>
object
name
required
string
label
required
string
type
required
string
options
required
object
required
required
boolean
items
Array<object>
object
id
required
integer
item_id
required
integer
name
required
string | null
code
required
string | null
image
required
string | null
brand
required
string | null
category
required
string | null
price
required
string | null
quantity
required
number | null
meta
required
object
created_at
string | null format: date-time
updated_at
string | null format: date-time
relationships
object
assignments
object
data
required
Array<object>
object
id
required
string
type
required
string
Allowed value: assignments
links
required
object
self
required
string
included
Array
Any of:
AssignmentResource
object
id
required
string
type
required
string
Allowed value: assignments
attributes
object
status
string
due_date
string | null format: date-time
completed_at
string | null format: date-time
notes
string | null
created_at
string | null format: date-time
updated_at
string | null format: date-time
relationships
object
auditType
object
data
required
object
id
required
string
type
required
string
Allowed value: audit_types
customer
object
data
required
object
id
required
string
type
required
string
Allowed value: customers
submission
object
data
required
object
id
required
string
type
required
string
Allowed value: submissions
links
required
object
self
required
string

Example 

{
  "data": {
    "type": "campaigns",
    "relationships": {
      "assignments": {
        "data": [
          {
            "type": "assignments"
          }
        ]
      }
    }
  },
  "included": [
    {
      "type": "assignments",
      "relationships": {
        "auditType": {
          "data": {
            "type": "audit_types"
          }
        },
        "customer": {
          "data": {
            "type": "customers"
          }
        },
        "submission": {
          "data": {
            "type": "submissions"
          }
        }
      }
    }
  ]
}

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.