v2.84.0

TS Dev 108 API Documentation

Download OpenAPI Document

JSON

Download OpenAPI Document

YAML

---

Customers

Endpoints to interact with customers

Operations

GET/api/v2/customersPOST/api/v2/customersGET/api/v2/customers/{id}DELETE/api/v2/customers/{id}PATCH/api/v2/customers/{id}POST/api/v2/customers/bulk-deleteGET/api/v2/customers/export

---

List customers

GET

/api/v2/customers

Get a list of customers

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Query Parameters

limit

Type

integer

Default

10

offset

Type

integer

Default

0

name

Type

string

email

Type

string

phone

Type

string

min_spent

Type

number

max_spent

Type

number

event

Type

integer

Responses

A list of customers

Content-Type

application/json

{

  

"count": 10,

  

"totalCount": 25,

  

"limit": 50,

  

"offset": 25,

  

"data": [

  

]

}

GET

/api/v2/customers

Playground

Authorization

bearerAuth

Variables

Key

Value

limit

offset

name

email

phone

min_spent

max_spent

event

Samples

---

Create customer

POST

/api/v2/customers

Create a new customer

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

"string"

Responses

Created customer

Content-Type

application/json

{

  

"data": "string"

}

POST

/api/v2/customers

Playground

Authorization

bearerAuth

Body

Samples

---

Get customer

GET

/api/v2/customers/{id}

Get a customer by ID

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Type

integer

Required

Responses

Customer details

Content-Type

application/json

{

  

"data": "string"

}

GET

/api/v2/customers/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

---

Delete customer

DELETE

/api/v2/customers/{id}

Delete a customer

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Type

integer

Required

Responses

Customer deleted

DELETE

/api/v2/customers/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

---

Update customer

PATCH

/api/v2/customers/{id}

Update an existing customer

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Type

integer

Required

Request Body

application/json

"string"

Responses

Updated customer

Content-Type

application/json

{

  

"data": "string"

}

PATCH

/api/v2/customers/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Body

Samples

---

Bulk delete customers

POST

/api/v2/customers/bulk-delete

Delete multiple customers

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

{

  

"ids": [

  

  

0

  

]

}

Responses

Customers deleted

POST

/api/v2/customers/bulk-delete

Playground

Authorization

bearerAuth

Body

Samples

---

Export customers as CSV

GET

/api/v2/customers/export

Downloads a CSV file containing customer details matching the given filters.

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Query Parameters

type

Filter by customer type (regular, guest, prospect)

Type

string

Valid values

"regular""guest""prospect"

eventType

Filter by event status (purchased, unpurchased)

Type

string

Valid values

"purchased""unpurchased"

eventSelection

Event IDs filter (upcoming, elapsed, or comma-separated IDs)

Type

string

Responses

CSV file download with customer details.

Content-Type

text/csv

"string"

GET

/api/v2/customers/export

Playground

Authorization

bearerAuth

Variables

Key

Value

type

eventType

eventSelection

Samples

---

Powered by VitePress OpenAPI