Skip to content
TradeOps Docs

List visits

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

Set mine=1 for the signed-in rep’s open visits, skipping closed campaigns. Results are paginated.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
currentTeam
required
string

The current team slug

Query Parameters

Section titled “Query Parameters”
mine
boolean

Only the signed-in rep’s visits, leaving out closed campaigns.

status
string

For example pending, in_progress or completed.

campaign_id
integer
per_page
integer
>= 1 <= 100
include
Array<string>
Allowed values: auditType auditType.fields auditType.fields.auditType auditType.fields.auditType.fields auditType.fields.auditType.fields.auditType customer customer.locations submission submission.auditType submission.auditType.fields submission.auditType.fields.auditType submission.auditType.fields.auditType.fields submission.customer submission.customer.locations
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”

Paginated set of AssignmentResource

Media typeapplication/vnd.api+json
object
data
required
Array<object>
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
links
required
object
first
required
string | null
last
required
string | null
prev
required
string | null
next
required
string | null
meta
required
object
current_page
required
integer
>= 1
from
required
integer | null
>= 1
last_page
required
integer
>= 1
links
required

Generated paginator links.

Array<object>
object
url
required
string | null
label
required
string
active
required
boolean
path
required

Base path for paginator generated URLs.

string | null
per_page
required

Number of items shown per page.

integer
to
required

Number of the last item in the slice.

integer | null
>= 1
total
required

Total number of items being paginated.

integer
included
Array
Any of:
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

Example 

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

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"
}

422

Section titled “422”

Validation error

Media typeapplication/json
object
message
required

Errors overview.

string
errors
required

A detailed description of each field that failed validation.

object
key
additional properties
Array<string>

Example generated

{
  "message": "example",
  "errors": {
    "additionalProperty": [
      "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.