Traction Guest API (0.13.0)

Download OpenAPI specification:Download

The Traction Guest API is currently in closed beta. We're still building, testing, and fixing bugs.

If you're interested in helping us get to version 1.0.0, contact your CS team representative. Only paid accounts are elligible.

Slack

Do you have Slack? Want faster answers to Traction Guest API questions?

Ask to be added to the Traction Guest API Slack channel!

Talk to your CS team representative, or send an email to the API support email above, and we'll add you.

Versioning

This API follows semantic versioning, which follows the Major.Minor.Patch format. In short:

  • The Major number increments when potentially incompatible changes are made.
  • The Minor number increments when backwards-compatible additions are made.
  • The Patch number increments when backwards-compatible bug-fixes are made.

So, once the API is out of closed beta, and has reached version 1.0.0, some things may change.

However, the developers at Traction Guest strive to keep things running smoothly for our clients. We plan to deprecate and warn before making any potentially breaking changes; you may receive messages that follow the format "this is deprecated, and will be removed in version X.X.X, which is scheduled for release on or after 20XX-01-01." Please note that the deprecation message format and content may change.

At this time, we are not planning to make older or 'legacy' versions of the API available, going forward.

Getting Started

Would you like your team to be a part of closed beta testing? Talk to your CS team representative. We'll walk you through the process of enabling API access and provisioning your account.

Authentication

TractionGuestAuth

Security Scheme Type Open ID Connect
Connect URL https://tractionguest.com/.well-known/openid-configuration

EmailTemplates

All endpoints relating to operations for the EmailTemplate model

List all EmailTemplates

Gets a list of all EmailTemplate entities.

Authorizations:
TractionGuestAuth (allopenidadmin:webhookswatchlists:*watchlists:readwatchlists:writeusers:*users:readusers:writevisitors:*visitors:readvisitors:writeparking:*parking:readparking:writelocations:*locations:readlocations:writehosts:*hosts:readhosts:writeemail_templates:*email_templates:reademail_templates:write)
query Parameters
limit
integer

Limits the results to a specified number, defaults to 50

offset
integer

Offsets the results to a specified number, defaults to 0

include
string

A list of comma-separated related models to include

Responses

Response samples

Content type
application/json
{
  • "email_templates":
    [
    ],
  • "pagination":
    {
    }
}

Hosts

All endpoints relating to the Host model

List all Hosts

Gets a list of all Host entities.

Authorizations:
TractionGuestAuth (allopenidadmin:webhookswatchlists:*watchlists:readwatchlists:writeusers:*users:readusers:writevisitors:*visitors:readvisitors:writeparking:*parking:readparking:writelocations:*locations:readlocations:writehosts:*hosts:readhosts:writeemail_templates:*email_templates:reademail_templates:write)
query Parameters
query
string

Will filter by first_name, last_name, and email

limit
integer

Limits the results to a specified number, defaults to 50

offset
integer

Offsets the results to a specified number, defaults to 0

include
string

A list of comma-separated related models to include

Responses

Response samples

Content type
application/json
{
  • "hosts":
    [
    ],
  • "pagination":
    {
    }
}

Create a Host

Creates a Host

Authorizations:
TractionGuestAuth (allopenidadmin:webhookswatchlists:*watchlists:readwatchlists:writeusers:*users:readusers:writevisitors:*visitors:readvisitors:writeparking:*parking:readparking:writelocations:*locations:readlocations:writehosts:*hosts:readhosts:writeemail_templates:*email_templates:reademail_templates:write)
header Parameters
Idempotency-Key
string

An optional idempotency key to allow for repeat API requests. Any API request with this key will only be executed once, no matter how many times it's submitted. We store idempotency keys for only 24 hours. Any Idempotency-Key shorter than 10 characters will be ignored

Request Body schema: application/json
email
string
first_name
string
last_name
string
profile_pic_url
string
department
string
mobile_number
string

Responses

Request samples

Content type
application/json
{
  • "email": "some text",
  • "first_name": "some text",
  • "last_name": "some text",
  • "profile_pic_url": "some text",
  • "department": "some text",
  • "mobile_number": "some text"
}

Response samples

Content type
application/json
{
  • "email": "some text",
  • "first_name": "some text",
  • "last_name": "some text",
  • "profile_pic_url": "some text",
  • "department": "some text",
  • "mobile_number": "some text"
}

Create multiple Hosts

Creates a batch of Host records in an async queue. Please note, every action taken against this endpoint is recorded in the audit log.

Authorizations: