INTIX
API docs by Redocly

API Reference

Download OpenAPI specification:

The INTIX API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

The INTIX API doesn’t support bulk updates. You can work on only one object per request.

Core Resources

List all customers

List all customers

Authorizations:
apiKey
query Parameters
page_number
integer >= 1
Default: 1

Page number for pagination (starts at 1).

limit
integer [ 1 .. 100 ]
Default: 20

Number of items per page (max 100).

search
string

Search field

sort_direction
string
Default: "desc"

asc or desc

sort_field
string

field to be sorted on

updated_since
integer

Only return customers that have been updated after this Unix timestamp (seconds).

Responses

Response samples

Content type
application/json
{
  • "object": "string",
  • "url": "string",
  • "has_more": true,
  • "org_id": "string",
  • "data": [
    ]
}

Retrieve a customer

Retrieve a customer

Authorizations:
apiKey
path Parameters
customer_id
required
string

Customer ID

Responses

Response samples

Content type
application/json
{
  • "add_date": 0,
  • "org_customer_id": "string",
  • "user_id": 0,
  • "org_id": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "email_address": "string",
  • "marketing_emails": true,
  • "mobile_number": "string",
  • "postcode": "string",
  • "new_event_notifications": true,
  • "updated_at": 0
}

Get organization info

Get organization info

Authorizations:
apiKey

Responses

Response samples

Content type
application/json
{
  • "org_id": "string",
  • "name": "string",
  • "company": "string",
  • "business_number": "string",
  • "stripe_account_id": "string",
  • "country": "string",
  • "country_name": "string",
  • "timezone": "string",
  • "logo_image": "string",
  • "background_image": "string",
  • "favicon": "string",
  • "background_color": "string"
}

Events

List all events for the organization

List all events for the organization

Authorizations:
apiKey
query Parameters
page_number
integer >= 1
Default: 1

Page number for pagination (starts at 1).

limit
integer [ 1 .. 100 ]
Default: 100

Number of items per page (max 100).

search
string

Search by event title or ID

integer or string
Default: "all"

Filter by event status. Use "all" for 0,1,3

Responses

Response samples

Content type
application/json
{
  • "object": "string",
  • "url": "string",
  • "has_more": true,
  • "org_id": "string",
  • "data": [
    ]
}

Get detailed scan data for an event

Get detailed scan data for an event

Authorizations:
apiKey
path Parameters
event_id
required
string

Event ID

query Parameters
page_number
integer >= 1
Default: 1

Page number for pagination

limit
integer [ 1 .. 2500 ]
Default: 100

Number of items per page (max 2500)

unix_start
integer

Filter scans after this unix timestamp

unix_end
integer

Filter scans before this unix timestamp

include_sales
boolean

Include tickets_sold count for each price_category

Responses

Response samples

Content type
application/json
{
  • "event_id": "string",
  • "total": 0,
  • "has_more": true,
  • "data": [
    ]
}

Get list of prices (tickets) attached to an event

Get list of prices (tickets) attached to an event

Authorizations:
apiKey
path Parameters
event_id
required
string

Event ID

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Get sold and attended stats by price category for

Get sold and attended stats by price category for an event. Sold value does not include cancelled or refunded tickets by default.

Authorizations:
apiKey
path Parameters
event_id
required
string

Event ID

query Parameters
include_cancelled
boolean

Include cancelled and refunded tickets in the 'sold' value

Responses

Response samples

Content type
application/json
{
  • "event_id": "string",
  • "data": [
    ]
}

Get sold and attended stats by price for an event.

Get sold and attended stats by price for an event. Sold value does not include cancelled or refunded tickets by default.

Authorizations:
apiKey
path Parameters
event_id
required
string

Event ID

query Parameters
include_cancelled
boolean

Include cancelled and refunded tickets in the 'sold' value

Responses

Response samples

Content type
application/json
{
  • "event_id": "string",
  • "data": [
    ]
}

Get a sales summary for an event.

Get a sales summary for an event.

Authorizations:
apiKey
path Parameters
event_id
required
string

Event ID

query Parameters
unix_start
integer

Filter orders after this unix timestamp

unix_end
integer

Filter orders before this unix timestamp

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "has_more": true
}

List the orders placed on an event, oldest first.

List the orders placed on an event, oldest first.

Authorizations:
apiKey
path Parameters
event_id
required
string

Event ID

query Parameters
page_number
integer >= 1
Default: 1

Page number for pagination (starts at 1).

limit
integer [ 1 .. 100 ]
Default: 20

Number of items per page (max 100).

string or string or string

Only return orders with this status.

search
string

Search by name, email address, order ID or order UUID.

unix_start
integer

Only return orders placed after this unix timestamp.

unix_end
integer

Only return orders placed before this unix timestamp.

Responses

Response samples

Content type
application/json
{
  • "object": "string",
  • "url": "string",
  • "has_more": true,
  • "event_id": "string",
  • "data": [
    ]
}

Membership

List all members. By default every member for the

List all members. By default every member for the organization is returned in a single response; pass limit to paginate through them instead.

Authorizations:
apiKey
query Parameters
updated_since
integer

Only return members that have been updated after this Unix timestamp (seconds). Members created after it that have not been updated since are also returned.

updated_until
integer

Only return members that were last updated before this Unix timestamp (seconds). Members that have never been updated are compared on their creation time.

created_since
integer

Only return members created after this Unix timestamp (seconds).

created_until
integer

Only return members created before this Unix timestamp (seconds).

string or string or string

Only return members with this fulfilment status. Matches the membership_fulfilled field: "yes" fulfilled, "no" unfulfilled, "reprint" the latest fulfilment record marks it as requiring a reprint.

membership_member_status_id
integer [ 0 .. 3 ]

Only return members with this membership status. 0 = Unpaid. 1 = Paid. 2 = Instalments outstanding. 3 = Cancelled. Omit to return members in every state.

membership_type_id
integer

Only return members holding this membership type/tier.

membership_seat_map_id
integer

Only return members whose membership type belongs to a category on this seat map.

limit
integer [ 1 .. 500 ]

Number of members to return per page (max 500). Omit to return every member in one response.

cursor
string

The next_cursor value returned by the previous page. Requires limit.

Responses

Response samples

Content type
application/json
{
  • "object": "string",
  • "url": "string",
  • "has_more": true,
  • "next_cursor": "string",
  • "data": [
    ]
}

Create a member

Create a member

Authorizations:
apiKey
Request Body schema: application/json
required
user_id
required
string

The user_id of a customer

first_name
required
string

First Name of the member

last_name
required
string

Last Name of the member

Responses

Request samples

Content type
application/json
{
  • "user_id": "string",
  • "first_name": "string",
  • "last_name": "string"
}

Response samples

Content type
application/json
{
  • "member_id": "string",
  • "first_name": "string"
}

Mark a specific set of members as fulfilled, optio

Mark a specific set of members as fulfilled, optionally recording a postage tracking code against each. Members already fulfilled keep their original fulfillment date, but any tracking code supplied for them is still recorded.

Authorizations:
apiKey
Request Body schema: application/json
required
required
Array of objects [ 1 .. 500 ] items

The members to mark as fulfilled. Maximum 500 per request.

Responses

Request samples

Content type
application/json
{
  • "members": [
    ]
}

Response samples

Content type
application/json
{
  • "members_fulfilled": 0,
  • "not_found": [
    ]
}

Update the fulfilment tracking code for a membersh

Update the fulfilment tracking code for a membership. Records the tracking code against the member and marks the order as fulfilled if it was not already.

Authorizations:
apiKey
path Parameters
membership_member_id
required
string

Unique identifier of the membership member to update.

Request Body schema: application/json
required
required
string or null

Postage tracking code to record against the member's fulfilment. Pass null to clear it.

Responses

Request samples

Content type
application/json
{
  • "fulfillment_tracking_code": "string"
}

Response samples

Content type
application/json
{
  • "membership_member_id": "string",
  • "fulfillment_tracking_code": "string"
}

Retrieve a member

Retrieve a member

Authorizations:
apiKey

Responses

Response samples

Content type
application/json
{
  • "org_id": "string"
}

List all membership types, including price, expiry

List all membership types, including price, expiry and auto-renew.

Authorizations:
apiKey

Responses

Response samples

Content type
application/json
{
  • "object": "string",
  • "url": "string",
  • "has_more": true,
  • "data": [
    ]
}

List all membership categories.

List all membership categories.

Authorizations:
apiKey

Responses

Response samples

Content type
application/json
{
  • "object": "string",
  • "url": "string",
  • "has_more": true,
  • "data": [
    ]
}

List all active membership payment options, includ

List all active membership payment options, including the number of instalments (payment plan) and whether the option auto-renews.

Authorizations:
apiKey

Responses

Response samples

Content type
application/json
{
  • "object": "string",
  • "url": "string",
  • "has_more": true,
  • "data": [
    ]
}

SSO

Endpoints for SSO integrations. The user must have linked their accounts first, otherwise requests return 403. Contact INTIX support if you wish to explore an SSO integration.

List the authenticated SSO user's INTIX orders for

List the authenticated SSO user's INTIX orders for this provider. Returns confirmed orders, newest event first. total is the order value (tickets price + fees). Requires a linked account; returns 403 if the SSO user is not linked to an INTIX account.

Authorizations:
apiKey

Responses

Response samples

Content type
application/json
{
  • "object": "string",
  • "data": [
    ]
}

List the active tickets in one of the authenticate

List the active tickets in one of the authenticated SSO user's orders. The order must belong to the user; returns an empty list otherwise. Requires a linked account (403 if not linked).

Authorizations:
apiKey
path Parameters
order_id
required
string

Responses

Response samples

Content type
application/json
{
  • "object": "string",
  • "data": [
    ]
}