API v2.0

CrowdPass API Documentation

The complete REST API reference for CrowdPass. Integrate event management, attendee registration, ticketing, and communication into your applications.

Modules

261

Endpoints

REST

Architecture

Quick Start

Get up and running with the CrowdPass API in three simple steps.

Authenticate

Get your API token by authenticating with your CrowdPass credentials.

Authenticate via Auth0

# Authenticate with Auth0 to get your access token
curl -X POST https://dashboard.crowdpass.co/api/public/users/auth0 \
  -H "Content-Type: application/json" \
  -d '{
    "email": "dev@yourcompany.com"
  }'

Make a request

Use your token to make authenticated API calls.

Make your first request

# List your events
curl https://dashboard.crowdpass.co/api/v1/events \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"

Explore the response

All responses return structured JSON with data and metadata.

Response

{
  "data": [
    {
      "id": 1234,
      "title": "Tech Conference 2026",
      "status": "Published",
      "startDate": "2026-06-15T09:00:00Z",
      "endDate": "2026-06-17T18:00:00Z"
    }
  ],
  "meta": { "total": 12, "page": 1 }
}

Learn more about authentication

Authentication

The CrowdPass API uses Auth0 for authentication. Authenticate via /api/public/users/auth0 to receive a JWT Bearer token. All authenticated endpoints require a valid token in the Authorization header.

Bearer Token — Include your token in every request:Authorization: Bearer <token>

Error Codes

Code	Name	Description
`401`	Unauthorized	Invalid or missing authentication token
`403`	Forbidden	Valid token but insufficient permissions
`429`	Rate Limited	Too many requests — retry after the Retry-After header value
`400`	Bad Request	Invalid request body or parameters
`404`	Not Found	Requested resource does not exist
`500`	Server Error	Internal server error — contact support if persistent

Auth0 authentication flow

// Authenticate via Auth0 endpoint
const response = await fetch(
  "https://dashboard.crowdpass.co/api/public/users/auth0",
  {
    method: "POST",
    headers: { "Content-Type": "application/json" },
    body: JSON.stringify({
      email: "dev@yourcompany.com",
    }),
  }
);
 
const { access_token } = await response.json();
 
// Use the token for subsequent requests
const events = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events",
  {
    headers: {
      Authorization: `Bearer ${access_token}`,
    },
  }
);

API Reference

Complete reference for all 25 modules and 261 endpoints.

Core

Authentication

User authentication via Auth0, account management, and email verification.

11 endpoints

GET/api/public/users/exists

Check if a user account exists by email

GEThttps://dashboard.crowdpass.co/api/public/users/exists

Request

import requests

url = "https://dashboard.crowdpass.co/api/public/users/exists"

response = requests.get(url)
print(response.json())

const response = await fetch("https://dashboard.crowdpass.co/api/public/users/exists");
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/public/users/exists

POST/api/public/users/verify-email

Verify a user email address with confirmation code

Parameters

codestring

required

POSThttps://dashboard.crowdpass.co/api/public/users/verify-email

Request

import requests

url = "https://dashboard.crowdpass.co/api/public/users/verify-email"

response = requests.post(url)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/public/users/verify-email",
  {
    method: "POST",
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/public/users/verify-email

POST/api/public/users/auth0

Authenticate via Auth0 and retrieve access token

Request Body

emailstringnullable

optional

POSThttps://dashboard.crowdpass.co/api/public/users/auth0

Request

import requests

url = "https://dashboard.crowdpass.co/api/public/users/auth0"
payload = {
  "email": null
}

response = requests.post(url, json=payload)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/public/users/auth0",
  {
    method: "POST",
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "email": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/public/users/auth0 \
  -H "Content-Type: application/json" \
  -d '{
    "email": null
  }'

POST/api/v1/users/continue

Continue account linking process

Requires authentication

Request Body

resultCommandResult

optional

primaryIdentityUserIdstringnullable

optional

sessionTokenstringnullable

optional

POSThttps://dashboard.crowdpass.co/api/v1/users/continue

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/users/continue"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "result": {},
  "primaryIdentityUserId": null,
  "sessionToken": null
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/users/continue",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "result": {},
      "primaryIdentityUserId": null,
      "sessionToken": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/users/continue \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "result": {},
    "primaryIdentityUserId": null,
    "sessionToken": null
  }'

GET/api/v1/users/current

Get current authenticated user profile

Requires authentication

Response· UserDto

emailstringnullable

optional

phoneNumberstringnullable

optional

firstNamestringnullable

optional

lastNamestringnullable

optional

idinteger (int32)

optional

emailVerifiedboolean

optional

profileCompletedboolean

optional

registrationCompletedboolean

optional

GEThttps://dashboard.crowdpass.co/api/v1/users/current

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/users/current"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/users/current",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/users/current \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "email": null,
  "phoneNumber": null,
  "firstName": null,
  "lastName": null,
  "id": 0,
  "emailVerified": false,
  "profileCompleted": false,
  "registrationCompleted": false,
  "isSuperAdmin": false,
  "isEnterpriseUser": false
}

PUT/api/v1/users/current

Update current user profile

Requires authentication

Request Body

emailstringnullable

optional

phoneNumberstringnullable

optional

firstNamestringnullable

optional

lastNamestringnullable

optional

PUThttps://dashboard.crowdpass.co/api/v1/users/current

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/users/current"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "email": null,
  "phoneNumber": null,
  "firstName": null,
  "lastName": null
}

response = requests.put(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/users/current",
  {
    method: "PUT",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "email": null,
      "phoneNumber": null,
      "firstName": null,
      "lastName": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X PUT https://dashboard.crowdpass.co/api/v1/users/current \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "email": null,
    "phoneNumber": null,
    "firstName": null,
    "lastName": null
  }'

DELETE/api/v1/users/current

Delete current user account

Requires authentication

DELETEhttps://dashboard.crowdpass.co/api/v1/users/current

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/users/current"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.delete(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/users/current",
  {
    method: "DELETE",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl -X DELETE https://dashboard.crowdpass.co/api/v1/users/current \
  -H "Authorization: Bearer YOUR_TOKEN"

POST/api/v1/users/from-identity

Create user account from identity provider

Requires authentication

Parameters

isAttendeeboolean

optional

Response· UserDto

emailstringnullable

optional

phoneNumberstringnullable

optional

firstNamestringnullable

optional

lastNamestringnullable

optional

idinteger (int32)

optional

emailVerifiedboolean

optional

profileCompletedboolean

optional

registrationCompletedboolean

optional

POSThttps://dashboard.crowdpass.co/api/v1/users/from-identity

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/users/from-identity"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.post(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/users/from-identity",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/users/from-identity \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "email": null,
  "phoneNumber": null,
  "firstName": null,
  "lastName": null,
  "id": 0,
  "emailVerified": false,
  "profileCompleted": false,
  "registrationCompleted": false,
  "isSuperAdmin": false,
  "isEnterpriseUser": false
}

POST/api/v1/users/complete

Complete user registration

Requires authentication

Request Body

emailstringnullable

optional

phoneNumberstringnullable

optional

firstNamestringnullable

optional

lastNamestringnullable

optional

POSThttps://dashboard.crowdpass.co/api/v1/users/complete

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/users/complete"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "email": null,
  "phoneNumber": null,
  "firstName": null,
  "lastName": null
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/users/complete",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "email": null,
      "phoneNumber": null,
      "firstName": null,
      "lastName": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/users/complete \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "email": null,
    "phoneNumber": null,
    "firstName": null,
    "lastName": null
  }'

POST/api/v1/users/email-confirmation

Resend email confirmation

Requires authentication

Parameters

isAttendeeboolean

optional

isTeammateboolean

optional

POSThttps://dashboard.crowdpass.co/api/v1/users/email-confirmation

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/users/email-confirmation"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.post(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/users/email-confirmation",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/users/email-confirmation \
  -H "Authorization: Bearer YOUR_TOKEN"

GET/api/v1/users/updateTeamWithInvitation

Accept team invitation and update membership

Requires authentication

Parameters

invitationCodestring

required

GEThttps://dashboard.crowdpass.co/api/v1/users/updateTeamWithInvitation

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/users/updateTeamWithInvitation"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/users/updateTeamWithInvitation",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/users/updateTeamWithInvitation \
  -H "Authorization: Bearer YOUR_TOKEN"

Companies

Company profile management, Stripe Connect, billing, and fee configuration.

16 endpoints

GET/api/v1/companies/exists

Check if a company exists for current user

Requires authentication

Parameters

companyNamestring

required

Response· CompanyExistsModel

existsboolean

optional

GEThttps://dashboard.crowdpass.co/api/v1/companies/exists

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/companies/exists"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/companies/exists",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/companies/exists \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "exists": false
}

GET/api/v1/companies/names

List company names for current user

Requires authentication

Parameters

pageSizeinteger (int32)

optional

currentPageinteger (int32)

optional

Response· GetCompanyNamesQueryResult

statusFeatureResultStatus

optional

dataobjectnullable

optional

messagestringnullable

optional

totalItemCountinteger (int32)

optional

GEThttps://dashboard.crowdpass.co/api/v1/companies/names

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/companies/names"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/companies/names",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/companies/names \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "status": {},
  "data": null,
  "message": null,
  "totalItemCount": 0
}

POST/api/v1/companies/top-up-credits

Purchase additional credits

Requires authentication

Request Body

companyIdinteger (int32)

optional

quantityinteger (int32)

optional

Response· CompanyExistsModel

existsboolean

optional

POSThttps://dashboard.crowdpass.co/api/v1/companies/top-up-credits

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/companies/top-up-credits"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "companyId": 0,
  "quantity": 0
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/companies/top-up-credits",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "companyId": 0,
      "quantity": 0
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/companies/top-up-credits \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "companyId": 0,
    "quantity": 0
  }'

Response

{
  "exists": false
}

GET/api/v1/companies/current

Get current company profile

Requires authentication

Response· CompanyDto

namestringnullable

optional

emailstringnullable

optional

phoneNumberstringnullable

optional

defaultLogoBlobIdinteger (int32)nullable

optional

defaultPageBackgroundBlobIdinteger (int32)nullable

optional

idinteger (int32)

optional

profileCompletedboolean

optional

hasActiveSubscriptionboolean

optional

GEThttps://dashboard.crowdpass.co/api/v1/companies/current

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/companies/current"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/companies/current",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/companies/current \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "name": null,
  "email": null,
  "phoneNumber": null,
  "defaultLogoBlobId": null,
  "defaultPageBackgroundBlobId": null,
  "id": 0,
  "profileCompleted": false,
  "hasActiveSubscription": false,
  "subscription": {},
  "extraRegistrations": 0,
  "stripeConnectAccountId": null,
  "stripeChargesEnabled": null,
  "stripePayoutsEnabled": null,
  "stripeAccountStatus": null,
  "hostCreatedTicketTypeFees": null
}

PUT/api/v1/companies/current

Update current company profile

Requires authentication

Request Body

namestringnullable

optional

emailstringnullable

optional

phoneNumberstringnullable

optional

defaultLogoBlobIdinteger (int32)nullable

optional

defaultPageBackgroundBlobIdinteger (int32)nullable

optional

PUThttps://dashboard.crowdpass.co/api/v1/companies/current

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/companies/current"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "name": null,
  "email": null,
  "phoneNumber": null,
  "defaultLogoBlobId": null,
  "defaultPageBackgroundBlobId": null
}

response = requests.put(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/companies/current",
  {
    method: "PUT",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": null,
      "email": null,
      "phoneNumber": null,
      "defaultLogoBlobId": null,
      "defaultPageBackgroundBlobId": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X PUT https://dashboard.crowdpass.co/api/v1/companies/current \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": null,
    "email": null,
    "phoneNumber": null,
    "defaultLogoBlobId": null,
    "defaultPageBackgroundBlobId": null
  }'

GET/api/v1/companies/current/fees

Get company fee configuration

Requires authentication

Response· CompanyDto

namestringnullable

optional

emailstringnullable

optional

phoneNumberstringnullable

optional

defaultLogoBlobIdinteger (int32)nullable

optional

defaultPageBackgroundBlobIdinteger (int32)nullable

optional

idinteger (int32)

optional

profileCompletedboolean

optional

hasActiveSubscriptionboolean

optional

GEThttps://dashboard.crowdpass.co/api/v1/companies/current/fees

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/companies/current/fees"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/companies/current/fees",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/companies/current/fees \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "name": null,
  "email": null,
  "phoneNumber": null,
  "defaultLogoBlobId": null,
  "defaultPageBackgroundBlobId": null,
  "id": 0,
  "profileCompleted": false,
  "hasActiveSubscription": false,
  "subscription": {},
  "extraRegistrations": 0,
  "stripeConnectAccountId": null,
  "stripeChargesEnabled": null,
  "stripePayoutsEnabled": null,
  "stripeAccountStatus": null,
  "hostCreatedTicketTypeFees": null
}

POST/api/v1/companies/complete

Complete company onboarding setup

Requires authentication

Request Body

namestringnullable

optional

emailstringnullable

optional

phoneNumberstringnullable

optional

Response· CompanyDto

namestringnullable

optional

emailstringnullable

optional

phoneNumberstringnullable

optional

defaultLogoBlobIdinteger (int32)nullable

optional

defaultPageBackgroundBlobIdinteger (int32)nullable

optional

idinteger (int32)

optional

profileCompletedboolean

optional

hasActiveSubscriptionboolean

optional

POSThttps://dashboard.crowdpass.co/api/v1/companies/complete

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/companies/complete"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "name": null,
  "email": null,
  "phoneNumber": null
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/companies/complete",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": null,
      "email": null,
      "phoneNumber": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/companies/complete \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": null,
    "email": null,
    "phoneNumber": null
  }'

Response

{
  "name": null,
  "email": null,
  "phoneNumber": null,
  "defaultLogoBlobId": null,
  "defaultPageBackgroundBlobId": null,
  "id": 0,
  "profileCompleted": false,
  "hasActiveSubscription": false,
  "subscription": {},
  "extraRegistrations": 0,
  "stripeConnectAccountId": null,
  "stripeChargesEnabled": null,
  "stripePayoutsEnabled": null,
  "stripeAccountStatus": null,
  "hostCreatedTicketTypeFees": null
}

GET/api/v1/companies/billing-history

Get company billing history

Requires authentication

GEThttps://dashboard.crowdpass.co/api/v1/companies/billing-history

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/companies/billing-history"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/companies/billing-history",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/companies/billing-history \
  -H "Authorization: Bearer YOUR_TOKEN"

GET/api/v1/companies/current/connect/stripe/account

Get Stripe Connect account details

Requires authentication

Response· Account

rawJObjectobjectnullable

optional

stripeResponseStripeResponse

optional

idstringnullable

optional

objectstringnullable

optional

businessProfileAccountBusinessProfile

optional

businessTypestringnullable

optional

capabilitiesAccountCapabilities

optional

chargesEnabledboolean

optional

GEThttps://dashboard.crowdpass.co/api/v1/companies/current/connect/stripe/account

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/companies/current/connect/stripe/account"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/companies/current/connect/stripe/account",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/companies/current/connect/stripe/account \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "rawJObject": null,
  "stripeResponse": {},
  "id": null,
  "object": null,
  "businessProfile": {},
  "businessType": null,
  "capabilities": {},
  "chargesEnabled": false,
  "company": {},
  "controller": {},
  "country": null,
  "created": "2026-01-01T00:00:00Z",
  "defaultCurrency": null,
  "deleted": null,
  "detailsSubmitted": false,
  "email": null,
  "externalAccounts": null,
  "futureRequirements": {},
  "individual": {},
  "metadata": null,
  "payoutsEnabled": false,
  "requirements": {},
  "settings": {},
  "tosAcceptance": {},
  "type": null
}

POST/api/v1/companies/current/connect/stripe

Initiate Stripe Connect onboarding

Requires authentication

POSThttps://dashboard.crowdpass.co/api/v1/companies/current/connect/stripe

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/companies/current/connect/stripe"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.post(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/companies/current/connect/stripe",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/companies/current/connect/stripe \
  -H "Authorization: Bearer YOUR_TOKEN"

POST/api/v1/companies/current/disconnect/stripe

Disconnect Stripe Connect account

Requires authentication

POSThttps://dashboard.crowdpass.co/api/v1/companies/current/disconnect/stripe

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/companies/current/disconnect/stripe"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.post(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/companies/current/disconnect/stripe",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/companies/current/disconnect/stripe \
  -H "Authorization: Bearer YOUR_TOKEN"

POST/api/v1/companies/current/connect/stripe/refresh-url

Refresh Stripe Connect onboarding URL

Requires authentication

POSThttps://dashboard.crowdpass.co/api/v1/companies/current/connect/stripe/refresh-url

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/companies/current/connect/stripe/refresh-url"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.post(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/companies/current/connect/stripe/refresh-url",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/companies/current/connect/stripe/refresh-url \
  -H "Authorization: Bearer YOUR_TOKEN"

POST/api/v1/companies/current/connect/stripe/complete

Complete Stripe Connect onboarding

Requires authentication

POSThttps://dashboard.crowdpass.co/api/v1/companies/current/connect/stripe/complete

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/companies/current/connect/stripe/complete"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.post(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/companies/current/connect/stripe/complete",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/companies/current/connect/stripe/complete \
  -H "Authorization: Bearer YOUR_TOKEN"

POST/api/v1/companies/current/connect/login-link

Generate Stripe Connect login link

Requires authentication

POSThttps://dashboard.crowdpass.co/api/v1/companies/current/connect/login-link

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/companies/current/connect/login-link"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.post(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/companies/current/connect/login-link",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/companies/current/connect/login-link \
  -H "Authorization: Bearer YOUR_TOKEN"

GET/api/v1/companies/current/connect/stripe/account/status

Get Stripe Connect account status

Requires authentication

GEThttps://dashboard.crowdpass.co/api/v1/companies/current/connect/stripe/account/status

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/companies/current/connect/stripe/account/status"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/companies/current/connect/stripe/account/status",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/companies/current/connect/stripe/account/status \
  -H "Authorization: Bearer YOUR_TOKEN"

GET/api/v1/companies/with-teammates

Get companies with teammate details

Requires authentication

Parameters

pageSizeinteger (int32)

optional

currentPageinteger (int32)

optional

searchstring

optional

Response· CompanyWithTeammatesDtoListQueryResultSlim

statusFeatureResultStatus

optional

dataobjectnullable

optional

messagestringnullable

optional

totalItemCountinteger (int32)

optional

GEThttps://dashboard.crowdpass.co/api/v1/companies/with-teammates

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/companies/with-teammates"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/companies/with-teammates",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/companies/with-teammates \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "status": {},
  "data": null,
  "message": null,
  "totalItemCount": 0
}

Teammates

Team member management, invitations, roles, and permissions.

11 endpoints

POST/api/v1/teammates/from-identity

Create teammate from identity provider

Requires authentication

Parameters

inviteCodestring

required

Response· TeammateDto

firstNamestringnullable

optional

lastNamestringnullable

optional

emailstringnullable

optional

roleIdinteger (int32)

optional

statusIdinteger (int32)

optional

idinteger (int32)

optional

POSThttps://dashboard.crowdpass.co/api/v1/teammates/from-identity

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/teammates/from-identity"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.post(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/teammates/from-identity",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/teammates/from-identity \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "firstName": null,
  "lastName": null,
  "email": null,
  "roleId": 0,
  "statusId": 0,
  "id": 0
}

POST/api/v1/teammates/manual

Manually create a teammate account

Requires authentication

Request Body

companyIdinteger (int32)

optional

emailstringnullable

optional

roleIdinteger (int32)

optional

firstNamestringnullable

optional

lastNamestringnullable

optional

isRemovebooleannullable

optional

Response· TeammateDto

firstNamestringnullable

optional

lastNamestringnullable

optional

emailstringnullable

optional

roleIdinteger (int32)

optional

statusIdinteger (int32)

optional

idinteger (int32)

optional

POSThttps://dashboard.crowdpass.co/api/v1/teammates/manual

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/teammates/manual"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "companyId": 0,
  "email": null,
  "roleId": 0,
  "firstName": null,
  "lastName": null,
  "isRemove": null
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/teammates/manual",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "companyId": 0,
      "email": null,
      "roleId": 0,
      "firstName": null,
      "lastName": null,
      "isRemove": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/teammates/manual \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "companyId": 0,
    "email": null,
    "roleId": 0,
    "firstName": null,
    "lastName": null,
    "isRemove": null
  }'

Response

{
  "firstName": null,
  "lastName": null,
  "email": null,
  "roleId": 0,
  "statusId": 0,
  "id": 0
}

GET/api/v1/teammates/{id}

Get teammate details

Requires authentication

Parameters

idinteger (int32)

required

Response· TeammateEventsDto

firstNamestringnullable

optional

lastNamestringnullable

optional

emailstringnullable

optional

roleIdinteger (int32)

optional

statusIdinteger (int32)

optional

idinteger (int32)

optional

eventsEventDto[]nullable

optional

GEThttps://dashboard.crowdpass.co/api/v1/teammates/{id}

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/teammates/{id}"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/teammates/{id}",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/teammates/{id} \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "firstName": null,
  "lastName": null,
  "email": null,
  "roleId": 0,
  "statusId": 0,
  "id": 0,
  "events": null
}

PUT/api/v1/teammates/{id}

Update teammate profile and role

Requires authentication

Parameters

idinteger (int32)

required

Request Body

firstNamestringnullable

optional

lastNamestringnullable

optional

emailstringnullable

optional

PUThttps://dashboard.crowdpass.co/api/v1/teammates/{id}

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/teammates/{id}"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "firstName": null,
  "lastName": null,
  "email": null
}

response = requests.put(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/teammates/{id}",
  {
    method: "PUT",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "firstName": null,
      "lastName": null,
      "email": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X PUT https://dashboard.crowdpass.co/api/v1/teammates/{id} \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "firstName": null,
    "lastName": null,
    "email": null
  }'

DELETE/api/v1/teammates/{id}

Remove teammate from company

Requires authentication

Parameters

idinteger (int32)

required

DELETEhttps://dashboard.crowdpass.co/api/v1/teammates/{id}

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/teammates/{id}"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.delete(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/teammates/{id}",
  {
    method: "DELETE",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl -X DELETE https://dashboard.crowdpass.co/api/v1/teammates/{id} \
  -H "Authorization: Bearer YOUR_TOKEN"

GET/api/v1/teammates

List all teammates

Requires authentication

Parameters

searchstring

optional

roleIdinteger (int32)

optional

pageSizeinteger (int32)

optional

currentPageinteger (int32)

optional

sortFieldsstring

optional

sortDirectionsstring

optional

Returns TeammateDto[]

GEThttps://dashboard.crowdpass.co/api/v1/teammates

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/teammates"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/teammates",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/teammates \
  -H "Authorization: Bearer YOUR_TOKEN"

POST/api/v1/teammates

Invite a new teammate

Requires authentication

Request Body

firstNamestringnullable

optional

lastNamestringnullable

optional

emailstringnullable

optional

roleIdinteger (int32)

optional

tenantIdinteger (int32)nullable

optional

Response· TeammateDto

firstNamestringnullable

optional

lastNamestringnullable

optional

emailstringnullable

optional

roleIdinteger (int32)

optional

statusIdinteger (int32)

optional

idinteger (int32)

optional

POSThttps://dashboard.crowdpass.co/api/v1/teammates

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/teammates"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "firstName": null,
  "lastName": null,
  "email": null,
  "roleId": 0,
  "tenantId": null
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/teammates",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "firstName": null,
      "lastName": null,
      "email": null,
      "roleId": 0,
      "tenantId": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/teammates \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "firstName": null,
    "lastName": null,
    "email": null,
    "roleId": 0,
    "tenantId": null
  }'

Response

{
  "firstName": null,
  "lastName": null,
  "email": null,
  "roleId": 0,
  "statusId": 0,
  "id": 0
}

POST/api/v1/teammates/search

Search teammates by name or email

Requires authentication

Request Body

pagingDataPagingData

optional

sortingDataSortingData

optional

filteringDataFilteringData

optional

Returns TeammateDto[]

POSThttps://dashboard.crowdpass.co/api/v1/teammates/search

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/teammates/search"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "pagingData": {},
  "sortingData": {},
  "filteringData": {}
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/teammates/search",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "pagingData": {},
      "sortingData": {},
      "filteringData": {}
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/teammates/search \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "pagingData": {},
    "sortingData": {},
    "filteringData": {}
  }'

POST/api/v1/teammates/{id}/send-invite

Resend teammate invitation email

Requires authentication

Parameters

idinteger (int32)

required

POSThttps://dashboard.crowdpass.co/api/v1/teammates/{id}/send-invite

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/teammates/{id}/send-invite"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.post(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/teammates/{id}/send-invite",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/teammates/{id}/send-invite \
  -H "Authorization: Bearer YOUR_TOKEN"

PUT/api/v1/teammates/{id}/events

Update teammate event assignments

Requires authentication

Parameters

idinteger (int32)

required

Request Body

addedEventsinteger[]nullable

optional

removedEventsinteger[]nullable

optional

PUThttps://dashboard.crowdpass.co/api/v1/teammates/{id}/events

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/teammates/{id}/events"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "addedEvents": null,
  "removedEvents": null
}

response = requests.put(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/teammates/{id}/events",
  {
    method: "PUT",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "addedEvents": null,
      "removedEvents": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X PUT https://dashboard.crowdpass.co/api/v1/teammates/{id}/events \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "addedEvents": null,
    "removedEvents": null
  }'

PATCH/api/v1/teammates/{id}/{property}/{newValue}

Patch a specific teammate property

Requires authentication

Parameters

idinteger (int32)

required

propertystring

required

newValuestring

required

PATCHhttps://dashboard.crowdpass.co/api/v1/teammates/{id}/{property}/{newValue}

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/teammates/{id}/{property}/{newValue}"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.patch(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/teammates/{id}/{property}/{newValue}",
  {
    method: "PATCH",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl -X PATCH https://dashboard.crowdpass.co/api/v1/teammates/{id}/{property}/{newValue} \
  -H "Authorization: Bearer YOUR_TOKEN"

Events

Event lifecycle management — creation, search, dashboard analytics, and duplication.

20 endpoints

GET/api/public/events/{publicId}

Get public event details

Parameters

publicIdstring

required

Response· PublicEventDto

titlestringnullable

optional

startDatestring (date-time)

optional

endDatestring (date-time)nullable

optional

timezoneOffsetinteger (int32)

optional

addressNamestringnullable

optional

addressDomainAddress

optional

contactEmailstringnullable

optional

contactPhoneNumberstringnullable

optional

GEThttps://dashboard.crowdpass.co/api/public/events/{publicId}

Request

import requests

url = "https://dashboard.crowdpass.co/api/public/events/{publicId}"

response = requests.get(url)
print(response.json())

const response = await fetch("https://dashboard.crowdpass.co/api/public/events/{publicId}");
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/public/events/{publicId}

Response

{
  "title": null,
  "startDate": "2026-01-01T00:00:00Z",
  "endDate": null,
  "timezoneOffset": 0,
  "addressName": null,
  "address": {},
  "contactEmail": null,
  "contactPhoneNumber": null,
  "hideDate": null,
  "registrationLink": null,
  "requireProfileImageOnRegistration": false,
  "hideFromSearchEngine": false,
  "isRegistrationEnabled": false,
  "maxGuestLimitPerAttendee": 0,
  "qrCodeCheckInField": null,
  "publicId": null,
  "statusId": 0,
  "about": null,
  "slug": null,
  "easyRegistration": false,
  "ogImageReferenceKey": null,
  "ogTitle": null,
  "ogDescription": null,
  "logoBlobReferenceKey": null,
  "pageBackgroundReferenceKey": null,
  "featureImageReferenceKey": null,
  "eventCardImageReferenceKey": null,
  "eventGalleryImages": null,
  "isAtCapacity": false,
  "longitude": null,
  "latitude": null,
  "companyName": null,
  "eventHeaderTextColor": null,
  "facebookURL": null,
  "instagramURL": null,
  "linkdinURL": null,
  "twitterURL": null,
  "tiktokURL": null,
  "videoURL": null,
  "publicRegistrationCode": null,
  "pageBackgroundColor": null,
  "customRegistrationQuestions": null,
  "ticketing": {},
  "smartCredentials": {},
  "eventTabs": null,
  "speakers": null,
  "isRegistrationPendingEnabled": false
}

GET/api/public/events/{publicId}/no-tickets

Get public event details without ticket info

Parameters

publicIdstring

required

Response· PublicEventDto

titlestringnullable

optional

startDatestring (date-time)

optional

endDatestring (date-time)nullable

optional

timezoneOffsetinteger (int32)

optional

addressNamestringnullable

optional

addressDomainAddress

optional

contactEmailstringnullable

optional

contactPhoneNumberstringnullable

optional

GEThttps://dashboard.crowdpass.co/api/public/events/{publicId}/no-tickets

Request

import requests

url = "https://dashboard.crowdpass.co/api/public/events/{publicId}/no-tickets"

response = requests.get(url)
print(response.json())

const response = await fetch("https://dashboard.crowdpass.co/api/public/events/{publicId}/no-tickets");
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/public/events/{publicId}/no-tickets

Response

{
  "title": null,
  "startDate": "2026-01-01T00:00:00Z",
  "endDate": null,
  "timezoneOffset": 0,
  "addressName": null,
  "address": {},
  "contactEmail": null,
  "contactPhoneNumber": null,
  "hideDate": null,
  "registrationLink": null,
  "requireProfileImageOnRegistration": false,
  "hideFromSearchEngine": false,
  "isRegistrationEnabled": false,
  "maxGuestLimitPerAttendee": 0,
  "qrCodeCheckInField": null,
  "publicId": null,
  "statusId": 0,
  "about": null,
  "slug": null,
  "easyRegistration": false,
  "ogImageReferenceKey": null,
  "ogTitle": null,
  "ogDescription": null,
  "logoBlobReferenceKey": null,
  "pageBackgroundReferenceKey": null,
  "featureImageReferenceKey": null,
  "eventCardImageReferenceKey": null,
  "eventGalleryImages": null,
  "isAtCapacity": false,
  "longitude": null,
  "latitude": null,
  "companyName": null,
  "eventHeaderTextColor": null,
  "facebookURL": null,
  "instagramURL": null,
  "linkdinURL": null,
  "twitterURL": null,
  "tiktokURL": null,
  "videoURL": null,
  "publicRegistrationCode": null,
  "pageBackgroundColor": null,
  "customRegistrationQuestions": null,
  "ticketing": {},
  "smartCredentials": {},
  "eventTabs": null,
  "speakers": null,
  "isRegistrationPendingEnabled": false
}

GET/api/public/events/slug/{slug}

Get public event by URL slug

Parameters

slugstring

required

Response· PublicEventDto

titlestringnullable

optional

startDatestring (date-time)

optional

endDatestring (date-time)nullable

optional

timezoneOffsetinteger (int32)

optional

addressNamestringnullable

optional

addressDomainAddress

optional

contactEmailstringnullable

optional

contactPhoneNumberstringnullable

optional

GEThttps://dashboard.crowdpass.co/api/public/events/slug/{slug}

Request

import requests

url = "https://dashboard.crowdpass.co/api/public/events/slug/{slug}"

response = requests.get(url)
print(response.json())

const response = await fetch("https://dashboard.crowdpass.co/api/public/events/slug/{slug}");
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/public/events/slug/{slug}

Response

{
  "title": null,
  "startDate": "2026-01-01T00:00:00Z",
  "endDate": null,
  "timezoneOffset": 0,
  "addressName": null,
  "address": {},
  "contactEmail": null,
  "contactPhoneNumber": null,
  "hideDate": null,
  "registrationLink": null,
  "requireProfileImageOnRegistration": false,
  "hideFromSearchEngine": false,
  "isRegistrationEnabled": false,
  "maxGuestLimitPerAttendee": 0,
  "qrCodeCheckInField": null,
  "publicId": null,
  "statusId": 0,
  "about": null,
  "slug": null,
  "easyRegistration": false,
  "ogImageReferenceKey": null,
  "ogTitle": null,
  "ogDescription": null,
  "logoBlobReferenceKey": null,
  "pageBackgroundReferenceKey": null,
  "featureImageReferenceKey": null,
  "eventCardImageReferenceKey": null,
  "eventGalleryImages": null,
  "isAtCapacity": false,
  "longitude": null,
  "latitude": null,
  "companyName": null,
  "eventHeaderTextColor": null,
  "facebookURL": null,
  "instagramURL": null,
  "linkdinURL": null,
  "twitterURL": null,
  "tiktokURL": null,
  "videoURL": null,
  "publicRegistrationCode": null,
  "pageBackgroundColor": null,
  "customRegistrationQuestions": null,
  "ticketing": {},
  "smartCredentials": {},
  "eventTabs": null,
  "speakers": null,
  "isRegistrationPendingEnabled": false
}

GET/api/public/events/{publicId}/qr-code

Get event QR code for public access

Parameters

publicIdstring

required

attendeeGroupAccessCodestring

optional

GEThttps://dashboard.crowdpass.co/api/public/events/{publicId}/qr-code

Request

import requests

url = "https://dashboard.crowdpass.co/api/public/events/{publicId}/qr-code"

response = requests.get(url)
print(response.json())

const response = await fetch("https://dashboard.crowdpass.co/api/public/events/{publicId}/qr-code");
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/public/events/{publicId}/qr-code

GET/api/v1/events/dashboard

Get events dashboard overview

Requires authentication

Parameters

searchstring

optional

yearinteger (int32)

optional

statusIdinteger (int32)

optional

pageSizeinteger (int32)

optional

currentPageinteger (int32)

optional

sortFieldsstring

optional

sortDirectionsstring

optional

Response· EnterpriseEventsDashboardQueryResult

statusFeatureResultStatus

optional

dataobjectnullable

optional

messagestringnullable

optional

totalItemCountinteger (int32)

optional

GEThttps://dashboard.crowdpass.co/api/v1/events/dashboard

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/dashboard"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/dashboard",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/events/dashboard \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "status": {},
  "data": null,
  "message": null,
  "totalItemCount": 0
}

GET/api/v1/events/dashboard/num-active

Get count of active events

Requires authentication

Response· CompanyDashboardDto

activeEventsinteger (int32)

optional

totalAttendeesinteger (int32)

optional

GEThttps://dashboard.crowdpass.co/api/v1/events/dashboard/num-active

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/dashboard/num-active"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/dashboard/num-active",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/events/dashboard/num-active \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "activeEvents": 0,
  "totalAttendees": 0
}

GET/api/v1/events/mobile-dashboard

Get mobile-optimized events dashboard

Requires authentication

Parameters

pageSizeinteger (int32)

optional

currentPageinteger (int32)

optional

sortFieldsstring

optional

sortDirectionsstring

optional

Response· EnterpriseEventsMobileDashboardQueryResult

statusFeatureResultStatus

optional

dataobjectnullable

optional

messagestringnullable

optional

upcomingEventsCountinteger (int32)

optional

pastEventsCountinteger (int32)

optional

numberOfAttendeesinteger (int32)

optional

totalItemCountinteger (int32)

optional

GEThttps://dashboard.crowdpass.co/api/v1/events/mobile-dashboard

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/mobile-dashboard"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/mobile-dashboard",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/events/mobile-dashboard \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "status": {},
  "data": null,
  "message": null,
  "upcomingEventsCount": 0,
  "pastEventsCount": 0,
  "numberOfAttendees": 0,
  "totalItemCount": 0
}

GET/api/v1/events/upcoming

List upcoming events

Requires authentication

Parameters

pageSizeinteger (int32)

optional

currentPageinteger (int32)

optional

sortFieldsstring

optional

sortDirectionsstring

optional

Response· EventsByTimeResult

statusFeatureResultStatus

optional

dataobjectnullable

optional

messagestringnullable

optional

totalItemCountinteger (int32)

optional

GEThttps://dashboard.crowdpass.co/api/v1/events/upcoming

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/upcoming"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/upcoming",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/events/upcoming \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "status": {},
  "data": null,
  "message": null,
  "totalItemCount": 0
}

GET/api/v1/events/past

List past events

Requires authentication

Parameters

pageSizeinteger (int32)

optional

currentPageinteger (int32)

optional

sortFieldsstring

optional

sortDirectionsstring

optional

Response· EventsByTimeResult

statusFeatureResultStatus

optional

dataobjectnullable

optional

messagestringnullable

optional

totalItemCountinteger (int32)

optional

GEThttps://dashboard.crowdpass.co/api/v1/events/past

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/past"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/past",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/events/past \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "status": {},
  "data": null,
  "message": null,
  "totalItemCount": 0
}

GET/api/v1/events/search-upcoming

Search upcoming events

Requires authentication

Parameters

searchTextstring

required

Returns MobileDashboardItemModel[]

GEThttps://dashboard.crowdpass.co/api/v1/events/search-upcoming

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/search-upcoming"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/search-upcoming",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/events/search-upcoming \
  -H "Authorization: Bearer YOUR_TOKEN"

GET/api/v1/events/search-past

Search past events

Requires authentication

Parameters

searchTextstring

required

Returns MobileDashboardItemModel[]

GEThttps://dashboard.crowdpass.co/api/v1/events/search-past

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/search-past"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/search-past",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/events/search-past \
  -H "Authorization: Bearer YOUR_TOKEN"

GET/api/v1/events/{id}/dashboard

Get single event dashboard analytics

Requires authentication

Parameters

idinteger (int32)

required

submissionStartDatestring

optional

Response· EventDashboardModel

titlestringnullable

optional

aboutstringnullable

optional

startDatestring (date-time)

optional

endDatestring (date-time)nullable

optional

attendeeGroupsAttendeeGroupDto[]nullable

optional

customRegistrationQuestionsCustomRegistrationQuestionDto[]nullable

optional

numberOfAttendeesinteger (int32)

optional

attendeesRegisteredinteger (int32)

optional

GEThttps://dashboard.crowdpass.co/api/v1/events/{id}/dashboard

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{id}/dashboard"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{id}/dashboard",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/events/{id}/dashboard \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "title": null,
  "about": null,
  "startDate": "2026-01-01T00:00:00Z",
  "endDate": null,
  "attendeeGroups": null,
  "customRegistrationQuestions": null,
  "numberOfAttendees": 0,
  "attendeesRegistered": 0,
  "attendeesCheckedIn": 0,
  "ticketing": {},
  "qrCodeCheckInField": null
}

GET/api/v1/events/{id}

Get event details by ID

Requires authentication

Parameters

idinteger (int32)

required

Response· EventDto

titlestringnullable

optional

startDatestring (date-time)

optional

endDatestring (date-time)nullable

optional

timezoneOffsetinteger (int32)

optional

addressNamestringnullable

optional

addressDomainAddress

optional

contactEmailstringnullable

optional

contactPhoneNumberstringnullable

optional

GEThttps://dashboard.crowdpass.co/api/v1/events/{id}

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{id}"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{id}",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/events/{id} \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "title": null,
  "startDate": "2026-01-01T00:00:00Z",
  "endDate": null,
  "timezoneOffset": 0,
  "addressName": null,
  "address": {},
  "contactEmail": null,
  "contactPhoneNumber": null,
  "hideDate": null,
  "registrationLink": null,
  "requireProfileImageOnRegistration": false,
  "hideFromSearchEngine": false,
  "isRegistrationEnabled": false,
  "maxGuestLimitPerAttendee": 0,
  "qrCodeCheckInField": null,
  "currentSetupStep": 0,
  "statusId": 0,
  "customRegistrationQuestions": null,
  "eventGalleryImages": null,
  "eventNotificationSettings": {},
  "about": null,
  "slug": null,
  "longitude": null,
  "latitude": null,
  "logoBlobId": null,
  "emailCoverBlobId": null,
  "pageBackgroundBlobId": null,
  "featureImageBlobId": null,
  "eventCardImageBlobId": null,
  "pageBackgroundColor": null,
  "ogImageBlobId": null,
  "ogTitle": null,
  "ogDescription": null,
  "requireAccessForLeadRetrieval": false,
  "contactCardsEnabled": false,
  "useLogoAndBackgroundInAllEvents": false,
  "invitationText": null,
  "invitationFooter": null,
  "smsContent": null,
  "registrationCapacity": null,
  "eventHeaderTextColor": null,
  "attendeeGroups": null,
  "id": 0,
  "publicId": null,
  "publicRegistrationCode": null,
  "easyRegistration": false,
  "isProcessed": false,
  "logoBlobReferenceKey": null,
  "pageBackgroundReferenceKey": null,
  "featureImageReferenceKey": null,
  "eventCardImageReferenceKey": null,
  "companyName": null,
  "submissionReceived": false,
  "facebookURL": null,
  "instagramURL": null,
  "linkdinURL": null,
  "twitterURL": null,
  "tiktokURL": null,
  "videoURL": null,
  "uniqueKey": null,
  "isRegistrationPendingEnabled": null,
  "ticketing": {},
  "smartCredentials": {},
  "eventTabs": null,
  "speakers": null
}

PUT/api/v1/events/{id}

Update event configuration

Requires authentication

Parameters

idinteger (int32)

required

Request Body

titlestringnullable

optional

startDatestring (date-time)

optional

endDatestring (date-time)nullable

optional

timezoneOffsetinteger (int32)

optional

addressNamestringnullable

optional

addressDomainAddress

optional

contactEmailstringnullable

optional

contactPhoneNumberstringnullable

optional

PUThttps://dashboard.crowdpass.co/api/v1/events/{id}

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{id}"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "title": null,
  "startDate": "2026-01-01T00:00:00Z",
  "endDate": null,
  "timezoneOffset": 0,
  "addressName": null,
  "address": {},
  "contactEmail": null,
  "contactPhoneNumber": null,
  "hideDate": null,
  "registrationLink": null,
  "requireProfileImageOnRegistration": false,
  "hideFromSearchEngine": false,
  "isRegistrationEnabled": false,
  "maxGuestLimitPerAttendee": 0,
  "qrCodeCheckInField": null,
  "currentSetupStep": 0,
  "statusId": 0,
  "customRegistrationQuestions": null,
  "eventGalleryImages": null,
  "eventNotificationSettings": {},
  "about": null,
  "slug": null,
  "longitude": null,
  "latitude": null,
  "logoBlobId": null,
  "emailCoverBlobId": null,
  "pageBackgroundBlobId": null,
  "featureImageBlobId": null,
  "eventCardImageBlobId": null,
  "pageBackgroundColor": null,
  "ogImageBlobId": null,
  "ogTitle": null,
  "ogDescription": null,
  "requireAccessForLeadRetrieval": false,
  "contactCardsEnabled": false,
  "useLogoAndBackgroundInAllEvents": false,
  "invitationText": null,
  "invitationFooter": null,
  "smsContent": null,
  "registrationCapacity": null,
  "eventHeaderTextColor": null,
  "attendeeGroups": null,
  "ticketing": {},
  "smartCredentials": {},
  "facebookURL": null,
  "instagramURL": null,
  "linkdinURL": null,
  "twitterURL": null,
  "tiktokURL": null,
  "videoURL": null,
  "isRegistrationPendingEnabled": null,
  "emailTemplateConnections": null
}

response = requests.put(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{id}",
  {
    method: "PUT",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "title": null,
      "startDate": "2026-01-01T00:00:00Z",
      "endDate": null,
      "timezoneOffset": 0,
      "addressName": null,
      "address": {},
      "contactEmail": null,
      "contactPhoneNumber": null,
      "hideDate": null,
      "registrationLink": null,
      "requireProfileImageOnRegistration": false,
      "hideFromSearchEngine": false,
      "isRegistrationEnabled": false,
      "maxGuestLimitPerAttendee": 0,
      "qrCodeCheckInField": null,
      "currentSetupStep": 0,
      "statusId": 0,
      "customRegistrationQuestions": null,
      "eventGalleryImages": null,
      "eventNotificationSettings": {},
      "about": null,
      "slug": null,
      "longitude": null,
      "latitude": null,
      "logoBlobId": null,
      "emailCoverBlobId": null,
      "pageBackgroundBlobId": null,
      "featureImageBlobId": null,
      "eventCardImageBlobId": null,
      "pageBackgroundColor": null,
      "ogImageBlobId": null,
      "ogTitle": null,
      "ogDescription": null,
      "requireAccessForLeadRetrieval": false,
      "contactCardsEnabled": false,
      "useLogoAndBackgroundInAllEvents": false,
      "invitationText": null,
      "invitationFooter": null,
      "smsContent": null,
      "registrationCapacity": null,
      "eventHeaderTextColor": null,
      "attendeeGroups": null,
      "ticketing": {},
      "smartCredentials": {},
      "facebookURL": null,
      "instagramURL": null,
      "linkdinURL": null,
      "twitterURL": null,
      "tiktokURL": null,
      "videoURL": null,
      "isRegistrationPendingEnabled": null,
      "emailTemplateConnections": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X PUT https://dashboard.crowdpass.co/api/v1/events/{id} \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "title": null,
    "startDate": "2026-01-01T00:00:00Z",
    "endDate": null,
    "timezoneOffset": 0,
    "addressName": null,
    "address": {},
    "contactEmail": null,
    "contactPhoneNumber": null,
    "hideDate": null,
    "registrationLink": null,
    "requireProfileImageOnRegistration": false,
    "hideFromSearchEngine": false,
    "isRegistrationEnabled": false,
    "maxGuestLimitPerAttendee": 0,
    "qrCodeCheckInField": null,
    "currentSetupStep": 0,
    "statusId": 0,
    "customRegistrationQuestions": null,
    "eventGalleryImages": null,
    "eventNotificationSettings": {},
    "about": null,
    "slug": null,
    "longitude": null,
    "latitude": null,
    "logoBlobId": null,
    "emailCoverBlobId": null,
    "pageBackgroundBlobId": null,
    "featureImageBlobId": null,
    "eventCardImageBlobId": null,
    "pageBackgroundColor": null,
    "ogImageBlobId": null,
    "ogTitle": null,
    "ogDescription": null,
    "requireAccessForLeadRetrieval": false,
    "contactCardsEnabled": false,
    "useLogoAndBackgroundInAllEvents": false,
    "invitationText": null,
    "invitationFooter": null,
    "smsContent": null,
    "registrationCapacity": null,
    "eventHeaderTextColor": null,
    "attendeeGroups": null,
    "ticketing": {},
    "smartCredentials": {},
    "facebookURL": null,
    "instagramURL": null,
    "linkdinURL": null,
    "twitterURL": null,
    "tiktokURL": null,
    "videoURL": null,
    "isRegistrationPendingEnabled": null,
    "emailTemplateConnections": null
  }'

DELETE/api/v1/events/{id}

Delete an event

Requires authentication

Parameters

idinteger (int32)

required

DELETEhttps://dashboard.crowdpass.co/api/v1/events/{id}

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{id}"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.delete(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{id}",
  {
    method: "DELETE",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl -X DELETE https://dashboard.crowdpass.co/api/v1/events/{id} \
  -H "Authorization: Bearer YOUR_TOKEN"

GET/api/v1/events

List all events

Requires authentication

Parameters

pageSizeinteger (int32)

optional

currentPageinteger (int32)

optional

sortFieldsstring

optional

sortDirectionsstring

optional

Returns EventDto[]

GEThttps://dashboard.crowdpass.co/api/v1/events

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/events \
  -H "Authorization: Bearer YOUR_TOKEN"

POST/api/v1/events

Create a new event

Requires authentication

Request Body

titlestringnullable

optional

startDatestring (date-time)

optional

endDatestring (date-time)nullable

optional

timezoneOffsetinteger (int32)

optional

addressNamestringnullable

optional

addressDomainAddress

optional

contactEmailstringnullable

optional

contactPhoneNumberstringnullable

optional

Response· EventDto

titlestringnullable

optional

startDatestring (date-time)

optional

endDatestring (date-time)nullable

optional

timezoneOffsetinteger (int32)

optional

addressNamestringnullable

optional

addressDomainAddress

optional

contactEmailstringnullable

optional

contactPhoneNumberstringnullable

optional

POSThttps://dashboard.crowdpass.co/api/v1/events

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "title": null,
  "startDate": "2026-01-01T00:00:00Z",
  "endDate": null,
  "timezoneOffset": 0,
  "addressName": null,
  "address": {},
  "contactEmail": null,
  "contactPhoneNumber": null,
  "hideDate": null,
  "registrationLink": null,
  "requireProfileImageOnRegistration": false,
  "hideFromSearchEngine": false,
  "isRegistrationEnabled": false,
  "maxGuestLimitPerAttendee": 0,
  "qrCodeCheckInField": null
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "title": null,
      "startDate": "2026-01-01T00:00:00Z",
      "endDate": null,
      "timezoneOffset": 0,
      "addressName": null,
      "address": {},
      "contactEmail": null,
      "contactPhoneNumber": null,
      "hideDate": null,
      "registrationLink": null,
      "requireProfileImageOnRegistration": false,
      "hideFromSearchEngine": false,
      "isRegistrationEnabled": false,
      "maxGuestLimitPerAttendee": 0,
      "qrCodeCheckInField": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/events \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "title": null,
    "startDate": "2026-01-01T00:00:00Z",
    "endDate": null,
    "timezoneOffset": 0,
    "addressName": null,
    "address": {},
    "contactEmail": null,
    "contactPhoneNumber": null,
    "hideDate": null,
    "registrationLink": null,
    "requireProfileImageOnRegistration": false,
    "hideFromSearchEngine": false,
    "isRegistrationEnabled": false,
    "maxGuestLimitPerAttendee": 0,
    "qrCodeCheckInField": null
  }'

Response

{
  "title": null,
  "startDate": "2026-01-01T00:00:00Z",
  "endDate": null,
  "timezoneOffset": 0,
  "addressName": null,
  "address": {},
  "contactEmail": null,
  "contactPhoneNumber": null,
  "hideDate": null,
  "registrationLink": null,
  "requireProfileImageOnRegistration": false,
  "hideFromSearchEngine": false,
  "isRegistrationEnabled": false,
  "maxGuestLimitPerAttendee": 0,
  "qrCodeCheckInField": null,
  "currentSetupStep": 0,
  "statusId": 0,
  "customRegistrationQuestions": null,
  "eventGalleryImages": null,
  "eventNotificationSettings": {},
  "about": null,
  "slug": null,
  "longitude": null,
  "latitude": null,
  "logoBlobId": null,
  "emailCoverBlobId": null,
  "pageBackgroundBlobId": null,
  "featureImageBlobId": null,
  "eventCardImageBlobId": null,
  "pageBackgroundColor": null,
  "ogImageBlobId": null,
  "ogTitle": null,
  "ogDescription": null,
  "requireAccessForLeadRetrieval": false,
  "contactCardsEnabled": false,
  "useLogoAndBackgroundInAllEvents": false,
  "invitationText": null,
  "invitationFooter": null,
  "smsContent": null,
  "registrationCapacity": null,
  "eventHeaderTextColor": null,
  "attendeeGroups": null,
  "id": 0,
  "publicId": null,
  "publicRegistrationCode": null,
  "easyRegistration": false,
  "isProcessed": false,
  "logoBlobReferenceKey": null,
  "pageBackgroundReferenceKey": null,
  "featureImageReferenceKey": null,
  "eventCardImageReferenceKey": null,
  "companyName": null,
  "submissionReceived": false,
  "facebookURL": null,
  "instagramURL": null,
  "linkdinURL": null,
  "twitterURL": null,
  "tiktokURL": null,
  "videoURL": null,
  "uniqueKey": null,
  "isRegistrationPendingEnabled": null,
  "ticketing": {},
  "smartCredentials": {},
  "eventTabs": null,
  "speakers": null
}

POST/api/v1/events/search

Search events by criteria

Requires authentication

Request Body

pagingDataPagingData

optional

sortingDataSortingData

optional

filteringDataFilteringData

optional

Returns EventDto[]

POSThttps://dashboard.crowdpass.co/api/v1/events/search

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/search"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "pagingData": {},
  "sortingData": {},
  "filteringData": {}
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/search",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "pagingData": {},
      "sortingData": {},
      "filteringData": {}
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/events/search \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "pagingData": {},
    "sortingData": {},
    "filteringData": {}
  }'

POST/api/v1/events/{id}/duplicate

Duplicate an existing event

Requires authentication

Parameters

idinteger (int32)

required

POSThttps://dashboard.crowdpass.co/api/v1/events/{id}/duplicate

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{id}/duplicate"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.post(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{id}/duplicate",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/events/{id}/duplicate \
  -H "Authorization: Bearer YOUR_TOKEN"

PATCH/api/v1/events/{id}/{property}/{newValue}

Patch a specific event property

Requires authentication

Parameters

idinteger (int32)

required

propertystring

required

newValuestring

required

PATCHhttps://dashboard.crowdpass.co/api/v1/events/{id}/{property}/{newValue}

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{id}/{property}/{newValue}"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.patch(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{id}/{property}/{newValue}",
  {
    method: "PATCH",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl -X PATCH https://dashboard.crowdpass.co/api/v1/events/{id}/{property}/{newValue} \
  -H "Authorization: Bearer YOUR_TOKEN"

Event Tabs

Custom tab management for event detail pages.

4 endpoints

GET/api/v1/events/{eventId}/eventTabs/{id}

Get event tab details

Requires authentication

Parameters

eventIdinteger (int32)

required

idinteger (int32)

required

Response· EventTabDto

aboutstringnullable

optional

GEThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/eventTabs/{id}

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/eventTabs/{id}"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/eventTabs/{id}",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/events/{eventId}/eventTabs/{id} \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "about": null
}

PUT/api/v1/events/{eventId}/eventTabs/{id}

Update event tab

Requires authentication

Parameters

eventIdinteger (int32)

required

idinteger (int32)

required

Request Body

aboutstringnullable

optional

Response· EventTabDto

aboutstringnullable

optional

PUThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/eventTabs/{id}

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/eventTabs/{id}"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "about": null
}

response = requests.put(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/eventTabs/{id}",
  {
    method: "PUT",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "about": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X PUT https://dashboard.crowdpass.co/api/v1/events/{eventId}/eventTabs/{id} \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "about": null
  }'

Response

{
  "about": null
}

DELETE/api/v1/events/{eventId}/eventTabs/{id}

Delete an event tab

Requires authentication

Parameters

eventIdinteger (int32)

required

idinteger (int32)

required

DELETEhttps://dashboard.crowdpass.co/api/v1/events/{eventId}/eventTabs/{id}

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/eventTabs/{id}"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.delete(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/eventTabs/{id}",
  {
    method: "DELETE",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl -X DELETE https://dashboard.crowdpass.co/api/v1/events/{eventId}/eventTabs/{id} \
  -H "Authorization: Bearer YOUR_TOKEN"

POST/api/v1/events/{eventId}/eventTabs

Create a new event tab

Requires authentication

Parameters

eventIdinteger (int32)

required

Request Body

aboutstringnullable

optional

Response· EventTabDto

aboutstringnullable

optional

POSThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/eventTabs

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/eventTabs"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "about": null
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/eventTabs",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "about": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/events/{eventId}/eventTabs \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "about": null
  }'

Response

{
  "about": null
}

Attendees

Attendee registration, check-in/out, import/export, search, and device management.

60 endpoints

GET/api/public/attendees/{publicId}

Get public attendee profile

Parameters

publicIdstring

required

Response· AttendeeDto

statusIdinteger (int32)

optional

eventIdinteger (int32)

optional

sourcestringnullable

optional

firstNamestringnullable

optional

lastNamestringnullable

optional

phoneNumberstringnullable

optional

emailstringnullable

optional

companystringnullable

optional

GEThttps://dashboard.crowdpass.co/api/public/attendees/{publicId}

Request

import requests

url = "https://dashboard.crowdpass.co/api/public/attendees/{publicId}"

response = requests.get(url)
print(response.json())

const response = await fetch("https://dashboard.crowdpass.co/api/public/attendees/{publicId}");
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/public/attendees/{publicId}

Response

{
  "statusId": 0,
  "eventId": 0,
  "source": null,
  "firstName": null,
  "lastName": null,
  "phoneNumber": null,
  "email": null,
  "company": null,
  "profilePhotoBlobId": null,
  "profilePhotoBlobReferenceKey": null,
  "identificationCardPhotoBlobId": null,
  "address": {},
  "dateOfBirth": null,
  "attendeeGroupId": null,
  "instagram": null,
  "twitter": null,
  "customUrl": null,
  "displayName": null,
  "contactCardPhotoUrl": null,
  "contactCardFirstName": null,
  "contactCardLastName": null,
  "publicEmail": null,
  "isLeadRetrievalEnabled": false,
  "id": 0,
  "publicId": null,
  "createdDate": "2026-01-01T00:00:00Z",
  "registrationDate": "2026-01-01T00:00:00Z",
  "checkInDate": "2026-01-01T00:00:00Z",
  "isRegistered": false,
  "isCheckedIn": false,
  "statusNote": null,
  "xmin": 0,
  "tickets": null,
  "checkInCount": null,
  "visits": null,
  "devices": null,
  "customRegistrationAnswers": null,
  "guestOfAttendeeId": null,
  "guestOfAttendee": {},
  "ownedGuests": null
}

GET/api/public/attendees/{publicId}/pass

Get attendee digital pass

Parameters

publicIdstring

required

Response· AttendeePassInformation

attendeeNamestringnullable

optional

eventNamestringnullable

optional

eventDatestring (date-time)

optional

eventLocationstringnullable

optional

attendeePublicIdstringnullable

optional

timezoneinteger (int32)

optional

latitudenumber (double)nullable

optional

longitudenumber (double)nullable

optional

GEThttps://dashboard.crowdpass.co/api/public/attendees/{publicId}/pass

Request

import requests

url = "https://dashboard.crowdpass.co/api/public/attendees/{publicId}/pass"

response = requests.get(url)
print(response.json())

const response = await fetch("https://dashboard.crowdpass.co/api/public/attendees/{publicId}/pass");
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/public/attendees/{publicId}/pass

Response

{
  "attendeeName": null,
  "eventName": null,
  "eventDate": "2026-01-01T00:00:00Z",
  "eventLocation": null,
  "attendeePublicId": null,
  "timezone": 0,
  "latitude": null,
  "longitude": null,
  "coverImage": null
}

GET/api/public/attendees/qr-code/{accessCode}

Get attendee QR code by access code

Parameters

accessCodestring

required

GEThttps://dashboard.crowdpass.co/api/public/attendees/qr-code/{accessCode}

Request

import requests

url = "https://dashboard.crowdpass.co/api/public/attendees/qr-code/{accessCode}"

response = requests.get(url)
print(response.json())

const response = await fetch("https://dashboard.crowdpass.co/api/public/attendees/qr-code/{accessCode}");
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/public/attendees/qr-code/{accessCode}

GET/api/v1/attendees/{publicId}/qr-code

Generate attendee QR code

Requires authentication

Parameters

publicIdstring

required

GEThttps://dashboard.crowdpass.co/api/v1/attendees/{publicId}/qr-code

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/attendees/{publicId}/qr-code"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/attendees/{publicId}/qr-code",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/attendees/{publicId}/qr-code \
  -H "Authorization: Bearer YOUR_TOKEN"

POST/api/v1/attendees/from-identity

Create attendee from identity provider

Requires authentication

Parameters

inviteCodestring

optional

eventRegistrationCodestring

optional

attendeeGroupAccessCodestring

optional

noCodeboolean

optional

Response· AttendeeDto

statusIdinteger (int32)

optional

eventIdinteger (int32)

optional

sourcestringnullable

optional

firstNamestringnullable

optional

lastNamestringnullable

optional

phoneNumberstringnullable

optional

emailstringnullable

optional

companystringnullable

optional

POSThttps://dashboard.crowdpass.co/api/v1/attendees/from-identity

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/attendees/from-identity"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.post(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/attendees/from-identity",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/attendees/from-identity \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "statusId": 0,
  "eventId": 0,
  "source": null,
  "firstName": null,
  "lastName": null,
  "phoneNumber": null,
  "email": null,
  "company": null,
  "profilePhotoBlobId": null,
  "profilePhotoBlobReferenceKey": null,
  "identificationCardPhotoBlobId": null,
  "address": {},
  "dateOfBirth": null,
  "attendeeGroupId": null,
  "instagram": null,
  "twitter": null,
  "customUrl": null,
  "displayName": null,
  "contactCardPhotoUrl": null,
  "contactCardFirstName": null,
  "contactCardLastName": null,
  "publicEmail": null,
  "isLeadRetrievalEnabled": false,
  "id": 0,
  "publicId": null,
  "createdDate": "2026-01-01T00:00:00Z",
  "registrationDate": "2026-01-01T00:00:00Z",
  "checkInDate": "2026-01-01T00:00:00Z",
  "isRegistered": false,
  "isCheckedIn": false,
  "statusNote": null,
  "xmin": 0,
  "tickets": null,
  "checkInCount": null,
  "visits": null,
  "devices": null,
  "customRegistrationAnswers": null,
  "guestOfAttendeeId": null,
  "guestOfAttendee": {},
  "ownedGuests": null
}

GET/api/v1/attendees/current/event/{publicEventId}

Get current attendee info for event

Requires authentication

Parameters

publicEventIdstring

required

Response· EventAttendeeDto

statusIdinteger (int32)

optional

eventIdinteger (int32)

optional

sourcestringnullable

optional

firstNamestringnullable

optional

lastNamestringnullable

optional

phoneNumberstringnullable

optional

emailstringnullable

optional

companystringnullable

optional

GEThttps://dashboard.crowdpass.co/api/v1/attendees/current/event/{publicEventId}

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/attendees/current/event/{publicEventId}"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/attendees/current/event/{publicEventId}",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/attendees/current/event/{publicEventId} \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "statusId": 0,
  "eventId": 0,
  "source": null,
  "firstName": null,
  "lastName": null,
  "phoneNumber": null,
  "email": null,
  "company": null,
  "profilePhotoBlobId": null,
  "profilePhotoBlobReferenceKey": null,
  "identificationCardPhotoBlobId": null,
  "address": {},
  "dateOfBirth": null,
  "attendeeGroupId": null,
  "instagram": null,
  "twitter": null,
  "customUrl": null,
  "displayName": null,
  "contactCardPhotoUrl": null,
  "contactCardFirstName": null,
  "contactCardLastName": null,
  "publicEmail": null,
  "isLeadRetrievalEnabled": false,
  "id": 0,
  "publicId": null,
  "createdDate": "2026-01-01T00:00:00Z",
  "registrationDate": "2026-01-01T00:00:00Z",
  "checkInDate": "2026-01-01T00:00:00Z",
  "isRegistered": false,
  "isCheckedIn": false,
  "statusNote": null,
  "xmin": 0,
  "tickets": null,
  "checkInCount": null,
  "visits": null,
  "devices": null,
  "customRegistrationAnswers": null,
  "guestOfAttendeeId": null,
  "guestOfAttendee": {},
  "ownedGuests": null,
  "ticketOrders": null,
  "event": {}
}

GET/api/v1/attendees/current/events

List events for current attendee

Requires authentication

Returns PublicEventAttendeeDto[]

GEThttps://dashboard.crowdpass.co/api/v1/attendees/current/events

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/attendees/current/events"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/attendees/current/events",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/attendees/current/events \
  -H "Authorization: Bearer YOUR_TOKEN"

GET/api/v1/attendees/current/tickets

List tickets for current attendee

Requires authentication

Returns TicketDto[]

GEThttps://dashboard.crowdpass.co/api/v1/attendees/current/tickets

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/attendees/current/tickets"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/attendees/current/tickets",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/attendees/current/tickets \
  -H "Authorization: Bearer YOUR_TOKEN"

GET/api/v1/attendees/{publicId}

Get attendee by public ID

Requires authentication

Parameters

publicIdstring

required

Response· AttendeeDto

statusIdinteger (int32)

optional

eventIdinteger (int32)

optional

sourcestringnullable

optional

firstNamestringnullable

optional

lastNamestringnullable

optional

phoneNumberstringnullable

optional

emailstringnullable

optional

companystringnullable

optional

GEThttps://dashboard.crowdpass.co/api/v1/attendees/{publicId}

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/attendees/{publicId}"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/attendees/{publicId}",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/attendees/{publicId} \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "statusId": 0,
  "eventId": 0,
  "source": null,
  "firstName": null,
  "lastName": null,
  "phoneNumber": null,
  "email": null,
  "company": null,
  "profilePhotoBlobId": null,
  "profilePhotoBlobReferenceKey": null,
  "identificationCardPhotoBlobId": null,
  "address": {},
  "dateOfBirth": null,
  "attendeeGroupId": null,
  "instagram": null,
  "twitter": null,
  "customUrl": null,
  "displayName": null,
  "contactCardPhotoUrl": null,
  "contactCardFirstName": null,
  "contactCardLastName": null,
  "publicEmail": null,
  "isLeadRetrievalEnabled": false,
  "id": 0,
  "publicId": null,
  "createdDate": "2026-01-01T00:00:00Z",
  "registrationDate": "2026-01-01T00:00:00Z",
  "checkInDate": "2026-01-01T00:00:00Z",
  "isRegistered": false,
  "isCheckedIn": false,
  "statusNote": null,
  "xmin": 0,
  "tickets": null,
  "checkInCount": null,
  "visits": null,
  "devices": null,
  "customRegistrationAnswers": null,
  "guestOfAttendeeId": null,
  "guestOfAttendee": {},
  "ownedGuests": null
}

GET/api/v1/attendees/{id}

Get attendee details by ID

Requires authentication

Parameters

idinteger (int32)

required

Response· AttendeeDto

statusIdinteger (int32)

optional

eventIdinteger (int32)

optional

sourcestringnullable

optional

firstNamestringnullable

optional

lastNamestringnullable

optional

phoneNumberstringnullable

optional

emailstringnullable

optional

companystringnullable

optional

GEThttps://dashboard.crowdpass.co/api/v1/attendees/{id}

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/attendees/{id}"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/attendees/{id}",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/attendees/{id} \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "statusId": 0,
  "eventId": 0,
  "source": null,
  "firstName": null,
  "lastName": null,
  "phoneNumber": null,
  "email": null,
  "company": null,
  "profilePhotoBlobId": null,
  "profilePhotoBlobReferenceKey": null,
  "identificationCardPhotoBlobId": null,
  "address": {},
  "dateOfBirth": null,
  "attendeeGroupId": null,
  "instagram": null,
  "twitter": null,
  "customUrl": null,
  "displayName": null,
  "contactCardPhotoUrl": null,
  "contactCardFirstName": null,
  "contactCardLastName": null,
  "publicEmail": null,
  "isLeadRetrievalEnabled": false,
  "id": 0,
  "publicId": null,
  "createdDate": "2026-01-01T00:00:00Z",
  "registrationDate": "2026-01-01T00:00:00Z",
  "checkInDate": "2026-01-01T00:00:00Z",
  "isRegistered": false,
  "isCheckedIn": false,
  "statusNote": null,
  "xmin": 0,
  "tickets": null,
  "checkInCount": null,
  "visits": null,
  "devices": null,
  "customRegistrationAnswers": null,
  "guestOfAttendeeId": null,
  "guestOfAttendee": {},
  "ownedGuests": null
}

PUT/api/v1/attendees/{id}

Update attendee information

Requires authentication

Parameters

idinteger (int32)

required

Request Body

statusIdinteger (int32)

optional

eventIdinteger (int32)

optional

sourcestringnullable

optional

firstNamestringnullable

optional

lastNamestringnullable

optional

phoneNumberstringnullable

optional

emailstringnullable

optional

companystringnullable

optional

PUThttps://dashboard.crowdpass.co/api/v1/attendees/{id}

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/attendees/{id}"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "statusId": 0,
  "eventId": 0,
  "source": null,
  "firstName": null,
  "lastName": null,
  "phoneNumber": null,
  "email": null,
  "company": null,
  "profilePhotoBlobId": null,
  "profilePhotoBlobReferenceKey": null,
  "identificationCardPhotoBlobId": null,
  "address": {},
  "dateOfBirth": null,
  "attendeeGroupId": null,
  "instagram": null,
  "twitter": null,
  "customUrl": null,
  "displayName": null,
  "contactCardPhotoUrl": null,
  "contactCardFirstName": null,
  "contactCardLastName": null,
  "publicEmail": null,
  "isLeadRetrievalEnabled": false,
  "customRegistrationAnswers": null,
  "finishRegistration": false,
  "attendeeGroupPublicAccessCode": null
}

response = requests.put(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/attendees/{id}",
  {
    method: "PUT",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "statusId": 0,
      "eventId": 0,
      "source": null,
      "firstName": null,
      "lastName": null,
      "phoneNumber": null,
      "email": null,
      "company": null,
      "profilePhotoBlobId": null,
      "profilePhotoBlobReferenceKey": null,
      "identificationCardPhotoBlobId": null,
      "address": {},
      "dateOfBirth": null,
      "attendeeGroupId": null,
      "instagram": null,
      "twitter": null,
      "customUrl": null,
      "displayName": null,
      "contactCardPhotoUrl": null,
      "contactCardFirstName": null,
      "contactCardLastName": null,
      "publicEmail": null,
      "isLeadRetrievalEnabled": false,
      "customRegistrationAnswers": null,
      "finishRegistration": false,
      "attendeeGroupPublicAccessCode": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X PUT https://dashboard.crowdpass.co/api/v1/attendees/{id} \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "statusId": 0,
    "eventId": 0,
    "source": null,
    "firstName": null,
    "lastName": null,
    "phoneNumber": null,
    "email": null,
    "company": null,
    "profilePhotoBlobId": null,
    "profilePhotoBlobReferenceKey": null,
    "identificationCardPhotoBlobId": null,
    "address": {},
    "dateOfBirth": null,
    "attendeeGroupId": null,
    "instagram": null,
    "twitter": null,
    "customUrl": null,
    "displayName": null,
    "contactCardPhotoUrl": null,
    "contactCardFirstName": null,
    "contactCardLastName": null,
    "publicEmail": null,
    "isLeadRetrievalEnabled": false,
    "customRegistrationAnswers": null,
    "finishRegistration": false,
    "attendeeGroupPublicAccessCode": null
  }'

DELETE/api/v1/attendees/{id}

Delete an attendee

Requires authentication

Parameters

idinteger (int32)

required

DELETEhttps://dashboard.crowdpass.co/api/v1/attendees/{id}

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/attendees/{id}"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.delete(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/attendees/{id}",
  {
    method: "DELETE",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl -X DELETE https://dashboard.crowdpass.co/api/v1/attendees/{id} \
  -H "Authorization: Bearer YOUR_TOKEN"

PATCH/api/v1/attendees/{id}/{property}/{newValue}

Patch a specific attendee property

Requires authentication

Parameters

idinteger (int32)

required

propertystring

required

newValuestring

required

notestring

optional

xminstring

optional

PATCHhttps://dashboard.crowdpass.co/api/v1/attendees/{id}/{property}/{newValue}

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/attendees/{id}/{property}/{newValue}"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.patch(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/attendees/{id}/{property}/{newValue}",
  {
    method: "PATCH",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl -X PATCH https://dashboard.crowdpass.co/api/v1/attendees/{id}/{property}/{newValue} \
  -H "Authorization: Bearer YOUR_TOKEN"

POST/api/v1/attendees/current/tickets/checkout

Start ticket checkout process

Requires authentication

Request Body

eventPublicIdstringnullable

optional

lineItemsTicketingLineItemsDto[]nullable

optional

Response· CreateTicketingCheckoutSessionResult

redirectUrlstringnullable

optional

POSThttps://dashboard.crowdpass.co/api/v1/attendees/current/tickets/checkout

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/attendees/current/tickets/checkout"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "eventPublicId": null,
  "lineItems": null
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/attendees/current/tickets/checkout",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "eventPublicId": null,
      "lineItems": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/attendees/current/tickets/checkout \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "eventPublicId": null,
    "lineItems": null
  }'

Response

{
  "redirectUrl": null
}

POST/api/v1/attendees/current/tickets/checkout/complete

Complete ticket checkout

Requires authentication

Request Body

checkoutSessionIdstringnullable

optional

ticketOrderPublicIdstringnullable

optional

Returns CompleteAttendeeTicketPaymentCheckoutResult

POSThttps://dashboard.crowdpass.co/api/v1/attendees/current/tickets/checkout/complete

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/attendees/current/tickets/checkout/complete"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "checkoutSessionId": null,
  "ticketOrderPublicId": null
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/attendees/current/tickets/checkout/complete",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "checkoutSessionId": null,
      "ticketOrderPublicId": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/attendees/current/tickets/checkout/complete \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "checkoutSessionId": null,
    "ticketOrderPublicId": null
  }'

GET/api/v1/attendees/current/ticketOrders

List ticket orders for current attendee

Requires authentication

Returns PublicTicketOrderAttendeeDto[]

GEThttps://dashboard.crowdpass.co/api/v1/attendees/current/ticketOrders

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/attendees/current/ticketOrders"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/attendees/current/ticketOrders",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/attendees/current/ticketOrders \
  -H "Authorization: Bearer YOUR_TOKEN"

GET/api/v1/attendees/current/ticketOrders/{ticketOrderPublicId}

Get ticket order details

Requires authentication

Parameters

ticketOrderPublicIdstring

required

Response· TicketOrderDto

publicIdstringnullable

optional

attendeeIdinteger (int32)

optional

isPaidboolean

optional

subtotalAmountnumber (double)nullable

optional

totalAmountnumber (double)nullable

optional

currencystringnullable

optional

cardBrandstringnullable

optional

cardLast4stringnullable

optional

GEThttps://dashboard.crowdpass.co/api/v1/attendees/current/ticketOrders/{ticketOrderPublicId}

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/attendees/current/ticketOrders/{ticketOrderPublicId}"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/attendees/current/ticketOrders/{ticketOrderPublicId}",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/attendees/current/ticketOrders/{ticketOrderPublicId} \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "publicId": null,
  "attendeeId": 0,
  "isPaid": false,
  "subtotalAmount": null,
  "totalAmount": null,
  "currency": null,
  "cardBrand": null,
  "cardLast4": null,
  "orderItems": null,
  "event": {}
}

GET/api/v1/attendees/current/scanned-contact-cards/{eventId}

Get scanned contact cards for event

Requires authentication

Parameters

eventIdinteger (int32)

required

GEThttps://dashboard.crowdpass.co/api/v1/attendees/current/scanned-contact-cards/{eventId}

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/attendees/current/scanned-contact-cards/{eventId}"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/attendees/current/scanned-contact-cards/{eventId}",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/attendees/current/scanned-contact-cards/{eventId} \
  -H "Authorization: Bearer YOUR_TOKEN"

POST/api/v1/attendees/current/scanned-contact-cards/{eventId}

Save a scanned contact card

Requires authentication

Parameters

eventIdinteger (int32)

required

Request Body

attendeeIdstringnullable

optional

notestringnullable

optional

POSThttps://dashboard.crowdpass.co/api/v1/attendees/current/scanned-contact-cards/{eventId}

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/attendees/current/scanned-contact-cards/{eventId}"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "attendeeId": null,
  "note": null
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/attendees/current/scanned-contact-cards/{eventId}",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "attendeeId": null,
      "note": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/attendees/current/scanned-contact-cards/{eventId} \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "attendeeId": null,
    "note": null
  }'

PUT/api/v1/attendees/current/scanned-contact-cards/{eventId}

Update scanned contact cards

Requires authentication

Parameters

eventIdinteger (int32)

required

Request Body

idinteger (int32)

optional

attendeeIdstringnullable

optional

notestringnullable

optional

PUThttps://dashboard.crowdpass.co/api/v1/attendees/current/scanned-contact-cards/{eventId}

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/attendees/current/scanned-contact-cards/{eventId}"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "id": 0,
  "attendeeId": null,
  "note": null
}

response = requests.put(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/attendees/current/scanned-contact-cards/{eventId}",
  {
    method: "PUT",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": 0,
      "attendeeId": null,
      "note": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X PUT https://dashboard.crowdpass.co/api/v1/attendees/current/scanned-contact-cards/{eventId} \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "id": 0,
    "attendeeId": null,
    "note": null
  }'

POST/api/v1/attendees/send-ticket-confirmation

Send ticket confirmation email

Requires authentication

POSThttps://dashboard.crowdpass.co/api/v1/attendees/send-ticket-confirmation

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/attendees/send-ticket-confirmation"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.post(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/attendees/send-ticket-confirmation",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/attendees/send-ticket-confirmation \
  -H "Authorization: Bearer YOUR_TOKEN"

DELETE/api/v1/{eventId}/attendees/bulk

Bulk delete attendees by event ID

Requires authentication

DELETEhttps://dashboard.crowdpass.co/api/v1/{eventId}/attendees/bulk

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/{eventId}/attendees/bulk"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.delete(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/{eventId}/attendees/bulk",
  {
    method: "DELETE",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl -X DELETE https://dashboard.crowdpass.co/api/v1/{eventId}/attendees/bulk \
  -H "Authorization: Bearer YOUR_TOKEN"

GET/api/v1/attendee-actions

List available attendee actions

Requires authentication

Parameters

attendeeIdinteger (int32)

required

Returns AttendeeActionDto[]

GEThttps://dashboard.crowdpass.co/api/v1/attendee-actions

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/attendee-actions"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/attendee-actions",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/attendee-actions \
  -H "Authorization: Bearer YOUR_TOKEN"

GET/api/v1/attendees/{id}/devices

List devices assigned to attendee

Requires authentication

Parameters

idinteger (int32)

required

Response· AttendeeDeviceDto

attendeeIdinteger (int32)nullable

optional

deviceUuidstringnullable

optional

metadataobjectnullable

optional

GEThttps://dashboard.crowdpass.co/api/v1/attendees/{id}/devices

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/attendees/{id}/devices"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/attendees/{id}/devices",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/attendees/{id}/devices \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "attendeeId": null,
  "deviceUuid": null,
  "metadata": null
}

POST/api/v1/attendees/{id}/devices

Assign device to attendee

Requires authentication

Parameters

idinteger (int32)

required

Request Body

attendeeIdinteger (int32)nullable

optional

deviceUuidstringnullable

optional

metadataobjectnullable

optional

Response· AttendeeDeviceDto

attendeeIdinteger (int32)nullable

optional

deviceUuidstringnullable

optional

metadataobjectnullable

optional

POSThttps://dashboard.crowdpass.co/api/v1/attendees/{id}/devices

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/attendees/{id}/devices"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "attendeeId": null,
  "deviceUuid": null,
  "metadata": null
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/attendees/{id}/devices",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "attendeeId": null,
      "deviceUuid": null,
      "metadata": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/attendees/{id}/devices \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "attendeeId": null,
    "deviceUuid": null,
    "metadata": null
  }'

Response

{
  "attendeeId": null,
  "deviceUuid": null,
  "metadata": null
}

DELETE/api/v1/attendees/{id}/devices/{deviceUuid}

Remove device from attendee

Requires authentication

Parameters

idinteger (int32)

required

deviceUuidstring

required

DELETEhttps://dashboard.crowdpass.co/api/v1/attendees/{id}/devices/{deviceUuid}

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/attendees/{id}/devices/{deviceUuid}"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.delete(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/attendees/{id}/devices/{deviceUuid}",
  {
    method: "DELETE",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl -X DELETE https://dashboard.crowdpass.co/api/v1/attendees/{id}/devices/{deviceUuid} \
  -H "Authorization: Bearer YOUR_TOKEN"

GET/api/v1/attendees/{eventId}/devices/{deviceUuid}

Get attendee by event and device

Requires authentication

Parameters

eventIdinteger (int32)

required

deviceUuidstring

required

Response· AttendeeDto

statusIdinteger (int32)

optional

eventIdinteger (int32)

optional

sourcestringnullable

optional

firstNamestringnullable

optional

lastNamestringnullable

optional

phoneNumberstringnullable

optional

emailstringnullable

optional

companystringnullable

optional

GEThttps://dashboard.crowdpass.co/api/v1/attendees/{eventId}/devices/{deviceUuid}

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/attendees/{eventId}/devices/{deviceUuid}"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/attendees/{eventId}/devices/{deviceUuid}",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/attendees/{eventId}/devices/{deviceUuid} \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "statusId": 0,
  "eventId": 0,
  "source": null,
  "firstName": null,
  "lastName": null,
  "phoneNumber": null,
  "email": null,
  "company": null,
  "profilePhotoBlobId": null,
  "profilePhotoBlobReferenceKey": null,
  "identificationCardPhotoBlobId": null,
  "address": {},
  "dateOfBirth": null,
  "attendeeGroupId": null,
  "instagram": null,
  "twitter": null,
  "customUrl": null,
  "displayName": null,
  "contactCardPhotoUrl": null,
  "contactCardFirstName": null,
  "contactCardLastName": null,
  "publicEmail": null,
  "isLeadRetrievalEnabled": false,
  "id": 0,
  "publicId": null,
  "createdDate": "2026-01-01T00:00:00Z",
  "registrationDate": "2026-01-01T00:00:00Z",
  "checkInDate": "2026-01-01T00:00:00Z",
  "isRegistered": false,
  "isCheckedIn": false,
  "statusNote": null,
  "xmin": 0,
  "tickets": null,
  "checkInCount": null,
  "visits": null,
  "devices": null,
  "customRegistrationAnswers": null,
  "guestOfAttendeeId": null,
  "guestOfAttendee": {},
  "ownedGuests": null
}

GET/api/v1/events/{eventId}/devices

List devices for event

Requires authentication

Parameters

eventIdinteger (int32)

required

Response· AttendeeDeviceDto

attendeeIdinteger (int32)nullable

optional

deviceUuidstringnullable

optional

metadataobjectnullable

optional

GEThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/devices

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/devices"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/devices",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/events/{eventId}/devices \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "attendeeId": null,
  "deviceUuid": null,
  "metadata": null
}

GET/api/v1/events/{eventId}/find-email-by-device/{deviceUuid}

Find attendee email by device UUID

Requires authentication

Parameters

eventIdinteger (int32)

required

deviceUuidstring

required

GEThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/find-email-by-device/{deviceUuid}

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/find-email-by-device/{deviceUuid}"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/find-email-by-device/{deviceUuid}",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/events/{eventId}/find-email-by-device/{deviceUuid} \
  -H "Authorization: Bearer YOUR_TOKEN"

POST/api/v1/events/{publicId}/attendees

Requires authentication

Parameters

publicIdstring

required

Request Body

profilePhotoBlobIdinteger (int32)nullable

optional

profilePhotoBlobReferenceKeystringnullable

optional

profilePhotoReferenceKeystringnullable

optional

emailstringnullable

optional

firstNamestringnullable

optional

lastNamestringnullable

optional

phoneNumberstringnullable

optional

inviteToRegisterboolean

optional

Response· AttendeeDto

statusIdinteger (int32)

optional

eventIdinteger (int32)

optional

sourcestringnullable

optional

firstNamestringnullable

optional

lastNamestringnullable

optional

phoneNumberstringnullable

optional

emailstringnullable

optional

companystringnullable

optional

POSThttps://dashboard.crowdpass.co/api/v1/events/{publicId}/attendees

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{publicId}/attendees"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "profilePhotoBlobId": null,
  "profilePhotoBlobReferenceKey": null,
  "profilePhotoReferenceKey": null,
  "email": null,
  "firstName": null,
  "lastName": null,
  "phoneNumber": null,
  "inviteToRegister": false,
  "attendeeGroupPublicAccessCode": null,
  "attendeeGroupAccessCode": null,
  "customRegistrationAnswers": null,
  "finishRegistration": false,
  "guestOfAttendeeId": null,
  "guests": null
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{publicId}/attendees",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "profilePhotoBlobId": null,
      "profilePhotoBlobReferenceKey": null,
      "profilePhotoReferenceKey": null,
      "email": null,
      "firstName": null,
      "lastName": null,
      "phoneNumber": null,
      "inviteToRegister": false,
      "attendeeGroupPublicAccessCode": null,
      "attendeeGroupAccessCode": null,
      "customRegistrationAnswers": null,
      "finishRegistration": false,
      "guestOfAttendeeId": null,
      "guests": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/events/{publicId}/attendees \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "profilePhotoBlobId": null,
    "profilePhotoBlobReferenceKey": null,
    "profilePhotoReferenceKey": null,
    "email": null,
    "firstName": null,
    "lastName": null,
    "phoneNumber": null,
    "inviteToRegister": false,
    "attendeeGroupPublicAccessCode": null,
    "attendeeGroupAccessCode": null,
    "customRegistrationAnswers": null,
    "finishRegistration": false,
    "guestOfAttendeeId": null,
    "guests": null
  }'

Response

{
  "statusId": 0,
  "eventId": 0,
  "source": null,
  "firstName": null,
  "lastName": null,
  "phoneNumber": null,
  "email": null,
  "company": null,
  "profilePhotoBlobId": null,
  "profilePhotoBlobReferenceKey": null,
  "identificationCardPhotoBlobId": null,
  "address": {},
  "dateOfBirth": null,
  "attendeeGroupId": null,
  "instagram": null,
  "twitter": null,
  "customUrl": null,
  "displayName": null,
  "contactCardPhotoUrl": null,
  "contactCardFirstName": null,
  "contactCardLastName": null,
  "publicEmail": null,
  "isLeadRetrievalEnabled": false,
  "id": 0,
  "publicId": null,
  "createdDate": "2026-01-01T00:00:00Z",
  "registrationDate": "2026-01-01T00:00:00Z",
  "checkInDate": "2026-01-01T00:00:00Z",
  "isRegistered": false,
  "isCheckedIn": false,
  "statusNote": null,
  "xmin": 0,
  "tickets": null,
  "checkInCount": null,
  "visits": null,
  "devices": null,
  "customRegistrationAnswers": null,
  "guestOfAttendeeId": null,
  "guestOfAttendee": {},
  "ownedGuests": null
}

GET/api/v1/events/{eventId}/attendees/dashboard

Get attendee dashboard analytics

Requires authentication

Parameters

eventIdinteger (int32)

required

searchstring

optional

statusIdinteger (int32)

optional

attendeeGroupIdinteger (int32)

optional

checkInStatusstring

optional

deviceIdstring

optional

hasDeviceboolean

optional

customFieldFiltersstring

optional

Response· EventAttendeesDashboardQueryResult

statusFeatureResultStatus

optional

dataobjectnullable

optional

messagestringnullable

optional

totalinteger (int32)

optional

checkedIninteger (int32)

optional

registeredinteger (int32)

optional

notRegisteredinteger (int32)

optional

contactCardScansinteger (int32)

optional

GEThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/dashboard

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/dashboard"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/dashboard",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/dashboard \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "status": {},
  "data": null,
  "message": null,
  "total": 0,
  "checkedIn": 0,
  "registered": 0,
  "notRegistered": 0,
  "contactCardScans": 0,
  "totalItemCount": 0
}

GET/api/v1/events/{eventId}/attendees/source-statistics

Get attendee source statistics

Requires authentication

Parameters

eventIdinteger (int32)

required

Response· AttendeeSourceStatisticsResult

statusFeatureResultStatus

optional

dataobjectnullable

optional

messagestringnullable

optional

GEThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/source-statistics

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/source-statistics"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/source-statistics",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/source-statistics \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "status": {},
  "data": null,
  "message": null
}

GET/api/v1/events/{eventId}/attendees/all-ids

Get all attendee IDs for event

Requires authentication

Parameters

eventIdinteger (int32)

required

searchstring

optional

statusIdinteger (int32)

optional

attendeeGroupIdinteger (int32)

optional

checkInStatusstring

optional

deviceIdstring

optional

hasDeviceboolean

optional

customFieldFiltersstring

optional

Response· GetAllAttendeeIdsQueryResult

statusFeatureResultStatus

optional

dataobjectnullable

optional

messagestringnullable

optional

attendeeIdsinteger[]nullable

optional

totalCountinteger (int32)

optional

GEThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/all-ids

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/all-ids"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/all-ids",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/all-ids \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "status": {},
  "data": null,
  "message": null,
  "attendeeIds": null,
  "totalCount": 0
}

GET/api/v1/events/{eventId}/attendees

List all attendees for an event

Requires authentication

Parameters

eventIdinteger (int32)

required

pageSizeinteger (int32)

optional

currentPageinteger (int32)

optional

sortFieldsstring

optional

sortDirectionsstring

optional

Returns AttendeeDto[]

GEThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees \
  -H "Authorization: Bearer YOUR_TOKEN"

POST/api/v1/events/{eventId}/attendees

Requires authentication

Parameters

eventIdinteger (int32)

required

Request Body

emailstringnullable

optional

firstNamestringnullable

optional

lastNamestringnullable

optional

phoneNumberstringnullable

optional

inviteToRegisterboolean

optional

finishRegistrationboolean

optional

attendeeGroupIdinteger (int32)nullable

optional

instagramstringnullable

optional

Response· AttendeeDto

statusIdinteger (int32)

optional

eventIdinteger (int32)

optional

sourcestringnullable

optional

firstNamestringnullable

optional

lastNamestringnullable

optional

phoneNumberstringnullable

optional

emailstringnullable

optional

companystringnullable

optional

POSThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "email": null,
  "firstName": null,
  "lastName": null,
  "phoneNumber": null,
  "inviteToRegister": false,
  "finishRegistration": false,
  "attendeeGroupId": null,
  "instagram": null,
  "twitter": null,
  "customUrl": null,
  "displayName": null,
  "contactCardPhotoUrl": null,
  "contactCardFirstName": null,
  "contactCardLastName": null,
  "company": null,
  "jobTitle": null,
  "linkedin": null,
  "publicEmail": null,
  "customRegistrationAnswers": null,
  "deviceUuid": null,
  "statusId": 0,
  "guestOfAttendeeId": null
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "email": null,
      "firstName": null,
      "lastName": null,
      "phoneNumber": null,
      "inviteToRegister": false,
      "finishRegistration": false,
      "attendeeGroupId": null,
      "instagram": null,
      "twitter": null,
      "customUrl": null,
      "displayName": null,
      "contactCardPhotoUrl": null,
      "contactCardFirstName": null,
      "contactCardLastName": null,
      "company": null,
      "jobTitle": null,
      "linkedin": null,
      "publicEmail": null,
      "customRegistrationAnswers": null,
      "deviceUuid": null,
      "statusId": 0,
      "guestOfAttendeeId": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "email": null,
    "firstName": null,
    "lastName": null,
    "phoneNumber": null,
    "inviteToRegister": false,
    "finishRegistration": false,
    "attendeeGroupId": null,
    "instagram": null,
    "twitter": null,
    "customUrl": null,
    "displayName": null,
    "contactCardPhotoUrl": null,
    "contactCardFirstName": null,
    "contactCardLastName": null,
    "company": null,
    "jobTitle": null,
    "linkedin": null,
    "publicEmail": null,
    "customRegistrationAnswers": null,
    "deviceUuid": null,
    "statusId": 0,
    "guestOfAttendeeId": null
  }'

Response

{
  "statusId": 0,
  "eventId": 0,
  "source": null,
  "firstName": null,
  "lastName": null,
  "phoneNumber": null,
  "email": null,
  "company": null,
  "profilePhotoBlobId": null,
  "profilePhotoBlobReferenceKey": null,
  "identificationCardPhotoBlobId": null,
  "address": {},
  "dateOfBirth": null,
  "attendeeGroupId": null,
  "instagram": null,
  "twitter": null,
  "customUrl": null,
  "displayName": null,
  "contactCardPhotoUrl": null,
  "contactCardFirstName": null,
  "contactCardLastName": null,
  "publicEmail": null,
  "isLeadRetrievalEnabled": false,
  "id": 0,
  "publicId": null,
  "createdDate": "2026-01-01T00:00:00Z",
  "registrationDate": "2026-01-01T00:00:00Z",
  "checkInDate": "2026-01-01T00:00:00Z",
  "isRegistered": false,
  "isCheckedIn": false,
  "statusNote": null,
  "xmin": 0,
  "tickets": null,
  "checkInCount": null,
  "visits": null,
  "devices": null,
  "customRegistrationAnswers": null,
  "guestOfAttendeeId": null,
  "guestOfAttendee": {},
  "ownedGuests": null
}

DELETE/api/v1/events/{eventId}/attendees

Bulk delete attendees from event

Requires authentication

Parameters

eventIdinteger (int32)

required

Request Body

attendeeIdsinteger[]nullable

optional

DELETEhttps://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "attendeeIds": null
}

response = requests.delete(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees",
  {
    method: "DELETE",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "attendeeIds": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X DELETE https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "attendeeIds": null
  }'

POST/api/v1/events/{eventId}/attendees/bulk-register

Bulk register attendees

Requires authentication

Parameters

eventIdinteger (int32)

required

Request Body

attendeeIdsinteger[]nullable

optional

POSThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/bulk-register

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/bulk-register"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "attendeeIds": null
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/bulk-register",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "attendeeIds": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/bulk-register \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "attendeeIds": null
  }'

POST/api/v1/events/{eventId}/attendees/search

Search attendees in event

Requires authentication

Request Body

pagingDataPagingData

optional

sortingDataSortingData

optional

filteringDataFilteringData

optional

eventIdinteger (int32)

optional

Returns AttendeeDto[]

POSThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/search

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/search"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "pagingData": {},
  "sortingData": {},
  "filteringData": {},
  "eventId": 0
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/search",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "pagingData": {},
      "sortingData": {},
      "filteringData": {},
      "eventId": 0
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/search \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "pagingData": {},
    "sortingData": {},
    "filteringData": {},
    "eventId": 0
  }'

GET/api/v1/events/{eventId}/attendees/getByEmail

Find attendee by email address

Requires authentication

Parameters

eventIdinteger (int32)

required

emailstring

required

Response· AttendeeDto

statusIdinteger (int32)

optional

eventIdinteger (int32)

optional

sourcestringnullable

optional

firstNamestringnullable

optional

lastNamestringnullable

optional

phoneNumberstringnullable

optional

emailstringnullable

optional

companystringnullable

optional

GEThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/getByEmail

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/getByEmail"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/getByEmail",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/getByEmail \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "statusId": 0,
  "eventId": 0,
  "source": null,
  "firstName": null,
  "lastName": null,
  "phoneNumber": null,
  "email": null,
  "company": null,
  "profilePhotoBlobId": null,
  "profilePhotoBlobReferenceKey": null,
  "identificationCardPhotoBlobId": null,
  "address": {},
  "dateOfBirth": null,
  "attendeeGroupId": null,
  "instagram": null,
  "twitter": null,
  "customUrl": null,
  "displayName": null,
  "contactCardPhotoUrl": null,
  "contactCardFirstName": null,
  "contactCardLastName": null,
  "publicEmail": null,
  "isLeadRetrievalEnabled": false,
  "id": 0,
  "publicId": null,
  "createdDate": "2026-01-01T00:00:00Z",
  "registrationDate": "2026-01-01T00:00:00Z",
  "checkInDate": "2026-01-01T00:00:00Z",
  "isRegistered": false,
  "isCheckedIn": false,
  "statusNote": null,
  "xmin": 0,
  "tickets": null,
  "checkInCount": null,
  "visits": null,
  "devices": null,
  "customRegistrationAnswers": null,
  "guestOfAttendeeId": null,
  "guestOfAttendee": {},
  "ownedGuests": null
}

GET/api/v1/events/{eventId}/attendees/searchByName

Search attendees by name

Requires authentication

Parameters

eventIdinteger (int32)

required

searchstring

required

Response· AttendeeDto

statusIdinteger (int32)

optional

eventIdinteger (int32)

optional

sourcestringnullable

optional

firstNamestringnullable

optional

lastNamestringnullable

optional

phoneNumberstringnullable

optional

emailstringnullable

optional

companystringnullable

optional

GEThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/searchByName

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/searchByName"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/searchByName",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/searchByName \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "statusId": 0,
  "eventId": 0,
  "source": null,
  "firstName": null,
  "lastName": null,
  "phoneNumber": null,
  "email": null,
  "company": null,
  "profilePhotoBlobId": null,
  "profilePhotoBlobReferenceKey": null,
  "identificationCardPhotoBlobId": null,
  "address": {},
  "dateOfBirth": null,
  "attendeeGroupId": null,
  "instagram": null,
  "twitter": null,
  "customUrl": null,
  "displayName": null,
  "contactCardPhotoUrl": null,
  "contactCardFirstName": null,
  "contactCardLastName": null,
  "publicEmail": null,
  "isLeadRetrievalEnabled": false,
  "id": 0,
  "publicId": null,
  "createdDate": "2026-01-01T00:00:00Z",
  "registrationDate": "2026-01-01T00:00:00Z",
  "checkInDate": "2026-01-01T00:00:00Z",
  "isRegistered": false,
  "isCheckedIn": false,
  "statusNote": null,
  "xmin": 0,
  "tickets": null,
  "checkInCount": null,
  "visits": null,
  "devices": null,
  "customRegistrationAnswers": null,
  "guestOfAttendeeId": null,
  "guestOfAttendee": {},
  "ownedGuests": null
}

GET/api/v1/events/{eventId}/attendees/searchByEmail

Search attendees by email

Requires authentication

Parameters

eventIdinteger (int32)

required

searchstring

required

Response· AttendeeDto

statusIdinteger (int32)

optional

eventIdinteger (int32)

optional

sourcestringnullable

optional

firstNamestringnullable

optional

lastNamestringnullable

optional

phoneNumberstringnullable

optional

emailstringnullable

optional

companystringnullable

optional

GEThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/searchByEmail

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/searchByEmail"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/searchByEmail",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/searchByEmail \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "statusId": 0,
  "eventId": 0,
  "source": null,
  "firstName": null,
  "lastName": null,
  "phoneNumber": null,
  "email": null,
  "company": null,
  "profilePhotoBlobId": null,
  "profilePhotoBlobReferenceKey": null,
  "identificationCardPhotoBlobId": null,
  "address": {},
  "dateOfBirth": null,
  "attendeeGroupId": null,
  "instagram": null,
  "twitter": null,
  "customUrl": null,
  "displayName": null,
  "contactCardPhotoUrl": null,
  "contactCardFirstName": null,
  "contactCardLastName": null,
  "publicEmail": null,
  "isLeadRetrievalEnabled": false,
  "id": 0,
  "publicId": null,
  "createdDate": "2026-01-01T00:00:00Z",
  "registrationDate": "2026-01-01T00:00:00Z",
  "checkInDate": "2026-01-01T00:00:00Z",
  "isRegistered": false,
  "isCheckedIn": false,
  "statusNote": null,
  "xmin": 0,
  "tickets": null,
  "checkInCount": null,
  "visits": null,
  "devices": null,
  "customRegistrationAnswers": null,
  "guestOfAttendeeId": null,
  "guestOfAttendee": {},
  "ownedGuests": null
}

GET/api/v1/events/{eventId}/attendees/searchByCustomAnswer

Search attendees by custom field answer

Requires authentication

Parameters

eventIdinteger (int32)

required

questionIdinteger (int32)

required

answerstring

required

Response· AttendeeDto

statusIdinteger (int32)

optional

eventIdinteger (int32)

optional

sourcestringnullable

optional

firstNamestringnullable

optional

lastNamestringnullable

optional

phoneNumberstringnullable

optional

emailstringnullable

optional

companystringnullable

optional

GEThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/searchByCustomAnswer

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/searchByCustomAnswer"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/searchByCustomAnswer",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/searchByCustomAnswer \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "statusId": 0,
  "eventId": 0,
  "source": null,
  "firstName": null,
  "lastName": null,
  "phoneNumber": null,
  "email": null,
  "company": null,
  "profilePhotoBlobId": null,
  "profilePhotoBlobReferenceKey": null,
  "identificationCardPhotoBlobId": null,
  "address": {},
  "dateOfBirth": null,
  "attendeeGroupId": null,
  "instagram": null,
  "twitter": null,
  "customUrl": null,
  "displayName": null,
  "contactCardPhotoUrl": null,
  "contactCardFirstName": null,
  "contactCardLastName": null,
  "publicEmail": null,
  "isLeadRetrievalEnabled": false,
  "id": 0,
  "publicId": null,
  "createdDate": "2026-01-01T00:00:00Z",
  "registrationDate": "2026-01-01T00:00:00Z",
  "checkInDate": "2026-01-01T00:00:00Z",
  "isRegistered": false,
  "isCheckedIn": false,
  "statusNote": null,
  "xmin": 0,
  "tickets": null,
  "checkInCount": null,
  "visits": null,
  "devices": null,
  "customRegistrationAnswers": null,
  "guestOfAttendeeId": null,
  "guestOfAttendee": {},
  "ownedGuests": null
}

GET/api/v1/events/{eventId}/attendees/exists

Check if attendee exists in event

Requires authentication

Parameters

eventIdinteger (int32)

required

Response· AttendeeDeviceDto

attendeeIdinteger (int32)nullable

optional

deviceUuidstringnullable

optional

metadataobjectnullable

optional

GEThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/exists

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/exists"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/exists",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/exists \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "attendeeId": null,
  "deviceUuid": null,
  "metadata": null
}

GET/api/v1/events/{eventId}/attendees/scanned-contact-cards

List scanned contact cards for event

Requires authentication

Parameters

eventIdinteger (int32)

required

searchstring

optional

pageSizeinteger (int32)

optional

currentPageinteger (int32)

optional

sortFieldsstring

optional

sortDirectionsstring

optional

GEThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/scanned-contact-cards

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/scanned-contact-cards"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/scanned-contact-cards",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/scanned-contact-cards \
  -H "Authorization: Bearer YOUR_TOKEN"

POST/api/v1/events/{eventId}/attendees/invite

Send invitation to attendee

Requires authentication

Parameters

eventIdinteger (int32)

required

Request Body

attendeeIdsinteger[]nullable

optional

POSThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/invite

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/invite"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "attendeeIds": null
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/invite",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "attendeeIds": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/invite \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "attendeeIds": null
  }'

POST/api/v1/events/{eventId}/attendees/qr-code/resend

Resend QR code to attendees

Requires authentication

Parameters

eventIdinteger (int32)

required

Request Body

attendeeIdsinteger[]nullable

optional

POSThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/qr-code/resend

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/qr-code/resend"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "attendeeIds": null
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/qr-code/resend",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "attendeeIds": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/qr-code/resend \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "attendeeIds": null
  }'

POST/api/v1/events/{eventId}/attendees/sms/send

Send SMS to event attendees

Requires authentication

Parameters

eventIdinteger (int32)

required

Request Body

messagestringnullable

optional

attendeeIdsinteger[]nullable

optional

deliveryDatestring (date-time)nullable

optional

smsCampaignIdinteger (int32)nullable

optional

POSThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/sms/send

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/sms/send"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "message": null,
  "attendeeIds": null,
  "deliveryDate": null,
  "smsCampaignId": null
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/sms/send",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "message": null,
      "attendeeIds": null,
      "deliveryDate": null,
      "smsCampaignId": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/sms/send \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "message": null,
    "attendeeIds": null,
    "deliveryDate": null,
    "smsCampaignId": null
  }'

POST/api/v1/events/{eventId}/attendees/email/send

Send email to event attendees

Requires authentication

Parameters

eventIdinteger (int32)

required

Request Body

subjectstringnullable

optional

messagestringnullable

optional

attendeeIdsinteger[]nullable

optional

deliveryDatestring (date-time)nullable

optional

POSThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/email/send

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/email/send"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "subject": null,
  "message": null,
  "attendeeIds": null,
  "deliveryDate": null
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/email/send",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "subject": null,
      "message": null,
      "attendeeIds": null,
      "deliveryDate": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/email/send \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "subject": null,
    "message": null,
    "attendeeIds": null,
    "deliveryDate": null
  }'

POST/api/v1/events/{eventId}/attendees/parse/blob/{blobId}

Parse attendee data from uploaded file

Requires authentication

Parameters

eventIdinteger (int32)

required

blobIdinteger (int32)

required

Request Body

proceedWithoutEmailsboolean

optional

inviteToRegisterboolean

optional

POSThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/parse/blob/{blobId}

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/parse/blob/{blobId}"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "proceedWithoutEmails": false,
  "inviteToRegister": false
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/parse/blob/{blobId}",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "proceedWithoutEmails": false,
      "inviteToRegister": false
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/parse/blob/{blobId} \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "proceedWithoutEmails": false,
    "inviteToRegister": false
  }'

POST/api/v1/events/{eventId}/attendees/{id}/checkin

Check in a specific attendee

Requires authentication

Parameters

eventIdinteger (int32)

required

idinteger (int32)

required

checkInMethodstring

optional

deviceNamestring

optional

gateIdinteger (int32)

optional

POSThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/{id}/checkin

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/{id}/checkin"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.post(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/{id}/checkin",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/{id}/checkin \
  -H "Authorization: Bearer YOUR_TOKEN"

POST/api/v1/events/{eventId}/attendees/checkin/{checkInCode}

Check in attendee by code

Requires authentication

Parameters

eventIdinteger (int32)

required

checkInCodestring

required

checkInMethodstring

optional

deviceNamestring

optional

gateIdinteger (int32)

optional

POSThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/checkin/{checkInCode}

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/checkin/{checkInCode}"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.post(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/checkin/{checkInCode}",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/checkin/{checkInCode} \
  -H "Authorization: Bearer YOUR_TOKEN"

POST/api/v1/events/{eventId}/attendees/{id}/check-out

Check out an attendee

Requires authentication

Parameters

eventIdinteger (int32)

required

idinteger (int32)

required

checkOutMethodstring

optional

deviceNamestring

optional

gateIdinteger (int32)

optional

POSThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/{id}/check-out

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/{id}/check-out"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.post(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/{id}/check-out",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/{id}/check-out \
  -H "Authorization: Bearer YOUR_TOKEN"

POST/api/v1/events/{eventId}/attendees/{id}/uncheckin

Undo attendee check-in

Requires authentication

Parameters

eventIdinteger (int32)

required

idinteger (int32)

required

POSThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/{id}/uncheckin

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/{id}/uncheckin"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.post(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/{id}/uncheckin",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/{id}/uncheckin \
  -H "Authorization: Bearer YOUR_TOKEN"

POST/api/v1/events/{eventId}/attendees/with-ticket

Requires authentication

Parameters

eventIdinteger (int32)

required

Request Body

firstNamestringnullable

optional

lastNamestringnullable

optional

emailstringnullable

optional

phoneNumberstringnullable

optional

inviteToRegisterboolean

optional

sendTicketEmailboolean

optional

ticketTypeIdinteger (int32)nullable

optional

customRegistrationAnswersUpdateCustomRegistrationAnswerDto[]nullable

optional

POSThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/with-ticket

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/with-ticket"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "firstName": null,
  "lastName": null,
  "email": null,
  "phoneNumber": null,
  "inviteToRegister": false,
  "sendTicketEmail": false,
  "ticketTypeId": null,
  "customRegistrationAnswers": null,
  "guestOfAttendeeId": null,
  "guests": null
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/with-ticket",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "firstName": null,
      "lastName": null,
      "email": null,
      "phoneNumber": null,
      "inviteToRegister": false,
      "sendTicketEmail": false,
      "ticketTypeId": null,
      "customRegistrationAnswers": null,
      "guestOfAttendeeId": null,
      "guests": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/with-ticket \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "firstName": null,
    "lastName": null,
    "email": null,
    "phoneNumber": null,
    "inviteToRegister": false,
    "sendTicketEmail": false,
    "ticketTypeId": null,
    "customRegistrationAnswers": null,
    "guestOfAttendeeId": null,
    "guests": null
  }'

DELETE/api/v1/events/{eventId}/attendees/bulk

Bulk delete selected attendees

Requires authentication

Parameters

eventIdinteger (int32)

required

Request Body

attendeeIdsinteger[]nullable

optional

DELETEhttps://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/bulk

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/bulk"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "attendeeIds": null
}

response = requests.delete(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/bulk",
  {
    method: "DELETE",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "attendeeIds": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X DELETE https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/bulk \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "attendeeIds": null
  }'

GET/api/v1/events/{eventId}/attendees/export/excel

Export attendees to Excel

Requires authentication

Parameters

eventIdinteger (int32)

required

searchstring

optional

GEThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/export/excel

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/export/excel"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/export/excel",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/export/excel \
  -H "Authorization: Bearer YOUR_TOKEN"

POST/api/v1/events/{eventId}/attendees/import/preview

Preview attendee import results

Requires authentication

Parameters

eventIdinteger (int32)

required

Request Body

blobIdinteger (int32)

optional

sheetNamestringnullable

optional

Response· PreviewImportResult

statusFeatureResultStatus

optional

dataobjectnullable

optional

messagestringnullable

optional

blobIdinteger (int32)

optional

columnsstring[]nullable

optional

sampleRowsobject[]nullable

optional

totalRowCountinteger (int32)

optional

sheetNamesstring[]nullable

optional

POSThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/import/preview

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/import/preview"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "blobId": 0,
  "sheetName": null
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/import/preview",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "blobId": 0,
      "sheetName": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/import/preview \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "blobId": 0,
    "sheetName": null
  }'

Response

{
  "status": {},
  "data": null,
  "message": null,
  "blobId": 0,
  "columns": null,
  "sampleRows": null,
  "totalRowCount": 0,
  "sheetNames": null,
  "errorMessage": null
}

POST/api/v1/events/{eventId}/attendees/import/validate

Validate attendee import file

Requires authentication

Parameters

eventIdinteger (int32)

required

Request Body

blobIdinteger (int32)

optional

sheetNamestringnullable

optional

columnMappingsColumnMappingDto[]nullable

optional

ticketTypeIdinteger (int32)nullable

optional

attendeeGroupIdinteger (int32)nullable

optional

Response· ValidateImportResult

statusFeatureResultStatus

optional

dataobjectnullable

optional

messagestringnullable

optional

validationSummaryValidationSummary

optional

rowValidationsRowValidation[]nullable

optional

errorMessagestringnullable

optional

POSThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/import/validate

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/import/validate"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "blobId": 0,
  "sheetName": null,
  "columnMappings": null,
  "ticketTypeId": null,
  "attendeeGroupId": null
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/import/validate",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "blobId": 0,
      "sheetName": null,
      "columnMappings": null,
      "ticketTypeId": null,
      "attendeeGroupId": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/import/validate \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "blobId": 0,
    "sheetName": null,
    "columnMappings": null,
    "ticketTypeId": null,
    "attendeeGroupId": null
  }'

Response

{
  "status": {},
  "data": null,
  "message": null,
  "validationSummary": {},
  "rowValidations": null,
  "errorMessage": null
}

POST/api/v1/events/{eventId}/attendees/import/execute

Execute attendee import

Requires authentication

Parameters

eventIdinteger (int32)

required

Request Body

blobIdinteger (int32)

optional

sheetNamestringnullable

optional

columnMappingsColumnMappingDto[]nullable

optional

ticketTypeIdinteger (int32)nullable

optional

attendeeGroupIdinteger (int32)nullable

optional

groupAssignmentModestringnullable

optional

groupAssignmentRulesGroupAssignmentRuleDto[]nullable

optional

inviteToRegisterboolean

optional

Response· BulkImportJobResponse

jobIdstringnullable

optional

statusstringnullable

optional

messagestringnullable

optional

POSThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/import/execute

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/import/execute"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "blobId": 0,
  "sheetName": null,
  "columnMappings": null,
  "ticketTypeId": null,
  "attendeeGroupId": null,
  "groupAssignmentMode": null,
  "groupAssignmentRules": null,
  "inviteToRegister": false,
  "sendTicketEmail": false,
  "skipInvalidRows": false,
  "updateExisting": false
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/import/execute",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "blobId": 0,
      "sheetName": null,
      "columnMappings": null,
      "ticketTypeId": null,
      "attendeeGroupId": null,
      "groupAssignmentMode": null,
      "groupAssignmentRules": null,
      "inviteToRegister": false,
      "sendTicketEmail": false,
      "skipInvalidRows": false,
      "updateExisting": false
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/events/{eventId}/attendees/import/execute \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "blobId": 0,
    "sheetName": null,
    "columnMappings": null,
    "ticketTypeId": null,
    "attendeeGroupId": null,
    "groupAssignmentMode": null,
    "groupAssignmentRules": null,
    "inviteToRegister": false,
    "sendTicketEmail": false,
    "skipInvalidRows": false,
    "updateExisting": false
  }'

Response

{
  "jobId": null,
  "status": null,
  "message": null
}

GET/api/v1/attendees/import/status/{jobId}

Check attendee import job status

Requires authentication

Parameters

jobIdstring

required

Response· BulkImportJobStatus

jobIdstringnullable

optional

statusstringnullable

optional

resultBulkImportResult

optional

GEThttps://dashboard.crowdpass.co/api/v1/attendees/import/status/{jobId}

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/attendees/import/status/{jobId}"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/attendees/import/status/{jobId}",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/attendees/import/status/{jobId} \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "jobId": null,
  "status": null,
  "result": {}
}

Attendee Groups

Group and segment attendees within events.

2 endpoints

POST/api/v1/events/{eventId}/groups

Create an attendee group

Requires authentication

Parameters

eventIdinteger (int32)

required

Request Body

namestringnullable

optional

colorstringnullable

optional

orderinteger (int32)

optional

Response· AttendeeGroupDto

namestringnullable

optional

colorstringnullable

optional

orderinteger (int32)

optional

idinteger (int32)

optional

isDefaultboolean

optional

publicAccessCodestringnullable

optional

POSThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/groups

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/groups"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "name": null,
  "color": null,
  "order": 0
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/groups",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": null,
      "color": null,
      "order": 0
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/events/{eventId}/groups \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": null,
    "color": null,
    "order": 0
  }'

Response

{
  "name": null,
  "color": null,
  "order": 0,
  "id": 0,
  "isDefault": false,
  "publicAccessCode": null
}

PATCH/api/v1/events/{eventId}/groups/{groupId}/{property}/{newValue}

Update an attendee group property

Requires authentication

Parameters

eventIdinteger (int32)

required

groupIdinteger (int32)

required

propertystring

required

newValuestring

required

xminstring

optional

PATCHhttps://dashboard.crowdpass.co/api/v1/events/{eventId}/groups/{groupId}/{property}/{newValue}

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/groups/{groupId}/{property}/{newValue}"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.patch(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/groups/{groupId}/{property}/{newValue}",
  {
    method: "PATCH",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl -X PATCH https://dashboard.crowdpass.co/api/v1/events/{eventId}/groups/{groupId}/{property}/{newValue} \
  -H "Authorization: Bearer YOUR_TOKEN"

Areas

Venue area and zone management with occupancy tracking and access control.

13 endpoints

GET/api/v1/events/{eventId}/areas/dashboard

Get areas dashboard overview

Requires authentication

Parameters

eventIdinteger (int32)

required

searchstring

optional

pageSizeinteger (int32)

optional

currentPageinteger (int32)

optional

sortFieldsstring

optional

sortDirectionsstring

optional

Response· EventAreasDashboardQueryResult

statusFeatureResultStatus

optional

dataobjectnullable

optional

messagestringnullable

optional

totalItemCountinteger (int32)

optional

GEThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/areas/dashboard

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/areas/dashboard"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/areas/dashboard",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/events/{eventId}/areas/dashboard \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "status": {},
  "data": null,
  "message": null,
  "totalItemCount": 0
}

GET/api/v1/events/{eventId}/areas

List all areas for an event

Requires authentication

Parameters

eventIdinteger (int32)

required

Response· EventAreasDashboardQueryResult

statusFeatureResultStatus

optional

dataobjectnullable

optional

messagestringnullable

optional

totalItemCountinteger (int32)

optional

GEThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/areas

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/areas"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/areas",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/events/{eventId}/areas \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "status": {},
  "data": null,
  "message": null,
  "totalItemCount": 0
}

POST/api/v1/events/{eventId}/areas

Create a new area

Requires authentication

Parameters

eventIdinteger (int32)

required

Request Body

namestringnullable

optional

maxCheckInsPerAttendeeinteger (int32)

optional

totalCheckInLimitinteger (int32)nullable

optional

backgroundBlobIdinteger (int32)nullable

optional

Response· EventAreaDto

namestringnullable

optional

maxCheckInsPerAttendeeinteger (int32)

optional

totalCheckInLimitinteger (int32)nullable

optional

backgroundBlobIdinteger (int32)nullable

optional

idinteger (int32)

optional

isDefaultboolean

optional

orderinteger (int32)

optional

eventAreaGatesEventAreaGateDto[]nullable

optional

POSThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/areas

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/areas"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "name": null,
  "maxCheckInsPerAttendee": 0,
  "totalCheckInLimit": null,
  "backgroundBlobId": null
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/areas",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": null,
      "maxCheckInsPerAttendee": 0,
      "totalCheckInLimit": null,
      "backgroundBlobId": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/events/{eventId}/areas \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": null,
    "maxCheckInsPerAttendee": 0,
    "totalCheckInLimit": null,
    "backgroundBlobId": null
  }'

Response

{
  "name": null,
  "maxCheckInsPerAttendee": 0,
  "totalCheckInLimit": null,
  "backgroundBlobId": null,
  "id": 0,
  "isDefault": false,
  "order": 0,
  "eventAreaGates": null,
  "eventAreaAttendeeGroups": null,
  "attendeeGroups": null
}

DELETE/api/v1/events/{eventId}/areas

Delete all areas for an event

Requires authentication

Parameters

eventIdinteger (int32)

required

Request Body

areaIdsinteger[]nullable

optional

Response· EventAreaDto

namestringnullable

optional

maxCheckInsPerAttendeeinteger (int32)

optional

totalCheckInLimitinteger (int32)nullable

optional

backgroundBlobIdinteger (int32)nullable

optional

idinteger (int32)

optional

isDefaultboolean

optional

orderinteger (int32)

optional

eventAreaGatesEventAreaGateDto[]nullable

optional

DELETEhttps://dashboard.crowdpass.co/api/v1/events/{eventId}/areas

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/areas"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "areaIds": null
}

response = requests.delete(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/areas",
  {
    method: "DELETE",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "areaIds": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X DELETE https://dashboard.crowdpass.co/api/v1/events/{eventId}/areas \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "areaIds": null
  }'

Response

{
  "name": null,
  "maxCheckInsPerAttendee": 0,
  "totalCheckInLimit": null,
  "backgroundBlobId": null,
  "id": 0,
  "isDefault": false,
  "order": 0,
  "eventAreaGates": null,
  "eventAreaAttendeeGroups": null,
  "attendeeGroups": null
}

GET/api/v1/events/{eventId}/areas/{areaId}/occupancy

Get real-time area occupancy

Requires authentication

Parameters

eventIdinteger (int32)

required

areaIdinteger (int32)

required

Response· EventAreasDashboardQueryResult

statusFeatureResultStatus

optional

dataobjectnullable

optional

messagestringnullable

optional

totalItemCountinteger (int32)

optional

GEThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/areas/{areaId}/occupancy

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/areas/{areaId}/occupancy"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/areas/{areaId}/occupancy",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/events/{eventId}/areas/{areaId}/occupancy \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "status": {},
  "data": null,
  "message": null,
  "totalItemCount": 0
}

GET/api/v1/events/{eventId}/areas/{areaId}

Get area details

Requires authentication

Parameters

eventIdinteger (int32)

required

areaIdinteger (int32)

required

Response· EventAreaDto

namestringnullable

optional

maxCheckInsPerAttendeeinteger (int32)

optional

totalCheckInLimitinteger (int32)nullable

optional

backgroundBlobIdinteger (int32)nullable

optional

idinteger (int32)

optional

isDefaultboolean

optional

orderinteger (int32)

optional

eventAreaGatesEventAreaGateDto[]nullable

optional

GEThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/areas/{areaId}

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/areas/{areaId}"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/areas/{areaId}",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/events/{eventId}/areas/{areaId} \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "name": null,
  "maxCheckInsPerAttendee": 0,
  "totalCheckInLimit": null,
  "backgroundBlobId": null,
  "id": 0,
  "isDefault": false,
  "order": 0,
  "eventAreaGates": null,
  "eventAreaAttendeeGroups": null,
  "attendeeGroups": null
}

PUT/api/v1/events/{eventId}/areas/{areaId}

Update area configuration

Requires authentication

Parameters

eventIdinteger (int32)

required

areaIdinteger (int32)

required

Request Body

namestringnullable

optional

maxCheckInsPerAttendeeinteger (int32)

optional

totalCheckInLimitinteger (int32)nullable

optional

backgroundBlobIdinteger (int32)nullable

optional

eventAreaGatesEventAreaGateDto[]nullable

optional

attendeeGroupsAttendeeGroupDto[]nullable

optional

eventAreaAttendeeGroupsEventAreaAttendeeGroupDto[]nullable

optional

Response· EventAreaDto

namestringnullable

optional

maxCheckInsPerAttendeeinteger (int32)

optional

totalCheckInLimitinteger (int32)nullable

optional

backgroundBlobIdinteger (int32)nullable

optional

idinteger (int32)

optional

isDefaultboolean

optional

orderinteger (int32)

optional

eventAreaGatesEventAreaGateDto[]nullable

optional

PUThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/areas/{areaId}

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/areas/{areaId}"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "name": null,
  "maxCheckInsPerAttendee": 0,
  "totalCheckInLimit": null,
  "backgroundBlobId": null,
  "eventAreaGates": null,
  "attendeeGroups": null,
  "eventAreaAttendeeGroups": null
}

response = requests.put(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/areas/{areaId}",
  {
    method: "PUT",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": null,
      "maxCheckInsPerAttendee": 0,
      "totalCheckInLimit": null,
      "backgroundBlobId": null,
      "eventAreaGates": null,
      "attendeeGroups": null,
      "eventAreaAttendeeGroups": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X PUT https://dashboard.crowdpass.co/api/v1/events/{eventId}/areas/{areaId} \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": null,
    "maxCheckInsPerAttendee": 0,
    "totalCheckInLimit": null,
    "backgroundBlobId": null,
    "eventAreaGates": null,
    "attendeeGroups": null,
    "eventAreaAttendeeGroups": null
  }'

Response

{
  "name": null,
  "maxCheckInsPerAttendee": 0,
  "totalCheckInLimit": null,
  "backgroundBlobId": null,
  "id": 0,
  "isDefault": false,
  "order": 0,
  "eventAreaGates": null,
  "eventAreaAttendeeGroups": null,
  "attendeeGroups": null
}

POST/api/v1/events/{eventId}/areas/{areaId}/duplicate

Duplicate an area

Requires authentication

Parameters

eventIdinteger (int32)

required

areaIdinteger (int32)

required

Response· EventAreaDto

namestringnullable

optional

maxCheckInsPerAttendeeinteger (int32)

optional

totalCheckInLimitinteger (int32)nullable

optional

backgroundBlobIdinteger (int32)nullable

optional

idinteger (int32)

optional

isDefaultboolean

optional

orderinteger (int32)

optional

eventAreaGatesEventAreaGateDto[]nullable

optional

POSThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/areas/{areaId}/duplicate

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/areas/{areaId}/duplicate"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.post(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/areas/{areaId}/duplicate",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/events/{eventId}/areas/{areaId}/duplicate \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "name": null,
  "maxCheckInsPerAttendee": 0,
  "totalCheckInLimit": null,
  "backgroundBlobId": null,
  "id": 0,
  "isDefault": false,
  "order": 0,
  "eventAreaGates": null,
  "eventAreaAttendeeGroups": null,
  "attendeeGroups": null
}

PATCH/api/v1/events/{eventId}/areas/{areaId}/{property}/{newValue}

Patch a specific area property

Requires authentication

Parameters

eventIdinteger (int32)

required

areaIdinteger (int32)

required

propertystring

required

newValuestring

required

PATCHhttps://dashboard.crowdpass.co/api/v1/events/{eventId}/areas/{areaId}/{property}/{newValue}

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/areas/{areaId}/{property}/{newValue}"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.patch(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/areas/{areaId}/{property}/{newValue}",
  {
    method: "PATCH",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl -X PATCH https://dashboard.crowdpass.co/api/v1/events/{eventId}/areas/{areaId}/{property}/{newValue} \
  -H "Authorization: Bearer YOUR_TOKEN"

GET/api/v1/events/{eventId}/areas/activity/dashboard

Get area activity dashboard

Requires authentication

Parameters

eventIdinteger (int32)

required

areaIdinteger (int32)

optional

typestring

optional

searchstring

optional

pageSizeinteger (int32)

optional

currentPageinteger (int32)

optional

sortFieldsstring

optional

sortDirectionsstring

optional

Response· UnifiedActivityDashboardQueryResult

statusFeatureResultStatus

optional

dataobjectnullable

optional

messagestringnullable

optional

totalItemCountinteger (int32)

optional

GEThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/areas/activity/dashboard

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/areas/activity/dashboard"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/areas/activity/dashboard",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/events/{eventId}/areas/activity/dashboard \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "status": {},
  "data": null,
  "message": null,
  "totalItemCount": 0
}

GET/api/v1/events/{eventId}/areas/summary

Get areas summary statistics

Requires authentication

Parameters

eventIdinteger (int32)

required

includeGatesboolean

required

Response· EventAreasSummaryQueryResult

statusFeatureResultStatus

optional

dataobjectnullable

optional

messagestringnullable

optional

totalItemCountinteger (int32)

optional

totalGateCountinteger (int32)

optional

totalVisitsCountinteger (int32)

optional

totalAttendeeCountinteger (int32)

optional

totalDeviceCountinteger (int32)

optional

GEThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/areas/summary

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/areas/summary"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/areas/summary",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/events/{eventId}/areas/summary \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "status": {},
  "data": null,
  "message": null,
  "totalItemCount": 0,
  "totalGateCount": 0,
  "totalVisitsCount": 0,
  "totalAttendeeCount": 0,
  "totalDeviceCount": 0
}

PUT/api/v1/events/{eventId}/areas/reorder

Reorder areas display order

Requires authentication

Parameters

eventIdinteger (int32)

required

Request Body

areaIdsinteger[]nullable

optional

PUThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/areas/reorder

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/areas/reorder"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "areaIds": null
}

response = requests.put(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/areas/reorder",
  {
    method: "PUT",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "areaIds": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X PUT https://dashboard.crowdpass.co/api/v1/events/{eventId}/areas/reorder \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "areaIds": null
  }'

DELETE/api/v1/events/visits

Clear all area visit records

Requires authentication

Request Body

visitIdsinteger[]nullable

optional

Response· CommandResult

statusFeatureResultStatus

optional

dataobjectnullable

optional

messagestringnullable

optional

DELETEhttps://dashboard.crowdpass.co/api/v1/events/visits

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/visits"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "visitIds": null
}

response = requests.delete(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/visits",
  {
    method: "DELETE",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "visitIds": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X DELETE https://dashboard.crowdpass.co/api/v1/events/visits \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "visitIds": null
  }'

Response

{
  "status": {},
  "data": null,
  "message": null
}

Speakers

Speaker profile management and session assignments.

5 endpoints

GET/api/v1/events/{eventId}/speakers

List all speakers for an event

Requires authentication

Parameters

eventIdinteger (int32)

required

Returns GetAllSpeakerByEventDto[]

GEThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/speakers

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/speakers"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/speakers",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/events/{eventId}/speakers \
  -H "Authorization: Bearer YOUR_TOKEN"

POST/api/v1/events/{eventId}/speakers

Add a new speaker

Requires authentication

Parameters

eventIdinteger (int32)

required

Request Body

firstNamestringnullable

optional

lastNamestringnullable

optional

jobTitlestringnullable

optional

descriptionstringnullable

optional

speakerLinksCreateSpeakerLinkDto[]nullable

optional

Response· CreateSpeakerDto

firstNamestringnullable

optional

lastNamestringnullable

optional

jobTitlestringnullable

optional

descriptionstringnullable

optional

speakerLinksCreateSpeakerLinkDto[]nullable

optional

POSThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/speakers

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/speakers"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "firstName": null,
  "lastName": null,
  "jobTitle": null,
  "description": null,
  "speakerLinks": null
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/speakers",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "firstName": null,
      "lastName": null,
      "jobTitle": null,
      "description": null,
      "speakerLinks": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/events/{eventId}/speakers \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "firstName": null,
    "lastName": null,
    "jobTitle": null,
    "description": null,
    "speakerLinks": null
  }'

Response

{
  "firstName": null,
  "lastName": null,
  "jobTitle": null,
  "description": null,
  "speakerLinks": null
}

GET/api/v1/events/{eventId}/speakers/{id}

Get speaker details

Requires authentication

Parameters

eventIdinteger (int32)

required

idinteger (int32)

required

Response· CreateSpeakerDto

firstNamestringnullable

optional

lastNamestringnullable

optional

jobTitlestringnullable

optional

descriptionstringnullable

optional

speakerLinksCreateSpeakerLinkDto[]nullable

optional

GEThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/speakers/{id}

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/speakers/{id}"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/speakers/{id}",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/events/{eventId}/speakers/{id} \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "firstName": null,
  "lastName": null,
  "jobTitle": null,
  "description": null,
  "speakerLinks": null
}

PUT/api/v1/events/{eventId}/speakers/{id}

Update speaker profile

Requires authentication

Parameters

eventIdinteger (int32)

required

idinteger (int32)

required

Request Body

firstNamestringnullable

optional

lastNamestringnullable

optional

jobTitlestringnullable

optional

descriptionstringnullable

optional

speakerLinksUpdateSpeakerLinkDto[]nullable

optional

Response· CreateSpeakerDto

firstNamestringnullable

optional

lastNamestringnullable

optional

jobTitlestringnullable

optional

descriptionstringnullable

optional

speakerLinksCreateSpeakerLinkDto[]nullable

optional

PUThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/speakers/{id}

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/speakers/{id}"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "firstName": null,
  "lastName": null,
  "jobTitle": null,
  "description": null,
  "speakerLinks": null
}

response = requests.put(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/speakers/{id}",
  {
    method: "PUT",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "firstName": null,
      "lastName": null,
      "jobTitle": null,
      "description": null,
      "speakerLinks": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X PUT https://dashboard.crowdpass.co/api/v1/events/{eventId}/speakers/{id} \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "firstName": null,
    "lastName": null,
    "jobTitle": null,
    "description": null,
    "speakerLinks": null
  }'

Response

{
  "firstName": null,
  "lastName": null,
  "jobTitle": null,
  "description": null,
  "speakerLinks": null
}

DELETE/api/v1/events/{eventId}/speakers/{id}

Remove speaker from event

Requires authentication

Parameters

eventIdinteger (int32)

required

idinteger (int32)

required

DELETEhttps://dashboard.crowdpass.co/api/v1/events/{eventId}/speakers/{id}

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/speakers/{id}"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.delete(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/speakers/{id}",
  {
    method: "DELETE",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl -X DELETE https://dashboard.crowdpass.co/api/v1/events/{eventId}/speakers/{id} \
  -H "Authorization: Bearer YOUR_TOKEN"

Ticketing

Ticket Types

Ticket type configuration, pricing, and sales dashboard.

8 endpoints

GET/api/v1/events/{eventId}/ticketTypes

List all ticket types for an event

Requires authentication

Parameters

eventIdinteger (int32)

required

searchstring

optional

pageSizeinteger (int32)

optional

currentPageinteger (int32)

optional

sortFieldsstring

optional

sortDirectionsstring

optional

Returns TicketTypeDto[]

GEThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/ticketTypes

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/ticketTypes"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/ticketTypes",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/events/{eventId}/ticketTypes \
  -H "Authorization: Bearer YOUR_TOKEN"

POST/api/v1/events/{eventId}/ticketTypes

Create a new ticket type

Requires authentication

Parameters

eventIdinteger (int32)

required

Request Body

namestringnullable

optional

priceinteger (int64)

optional

quantityAvailableinteger (int32)

optional

enableLimitQuantityPerAttendeeboolean

optional

quantityLimitPerAttendeeinteger (int32)

optional

descriptionstringnullable

optional

enableShowTicketDescriptionOnEventNameboolean

optional

enableIsOnSaleboolean

optional

Response· TicketTypeDto

publicIdstringnullable

optional

namestringnullable

optional

priceinteger (int64)

optional

quantityAvailableinteger (int32)

optional

enableLimitQuantityPerAttendeeboolean

optional

quantityLimitPerAttendeeinteger (int32)

optional

descriptionstringnullable

optional

enableShowTicketDescriptionOnEventNameboolean

optional

POSThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/ticketTypes

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/ticketTypes"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "name": null,
  "price": 0,
  "quantityAvailable": 0,
  "enableLimitQuantityPerAttendee": false,
  "quantityLimitPerAttendee": 0,
  "description": null,
  "enableShowTicketDescriptionOnEventName": false,
  "enableIsOnSale": false,
  "enableHostFees": false,
  "enableTransferable": false,
  "attendeeGroupPublicAccessCode": null,
  "attendeeGroups": null,
  "ticketRules": null,
  "priceIncludesPlatformFees": false,
  "hostFeePublicIds": null
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/ticketTypes",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": null,
      "price": 0,
      "quantityAvailable": 0,
      "enableLimitQuantityPerAttendee": false,
      "quantityLimitPerAttendee": 0,
      "description": null,
      "enableShowTicketDescriptionOnEventName": false,
      "enableIsOnSale": false,
      "enableHostFees": false,
      "enableTransferable": false,
      "attendeeGroupPublicAccessCode": null,
      "attendeeGroups": null,
      "ticketRules": null,
      "priceIncludesPlatformFees": false,
      "hostFeePublicIds": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/events/{eventId}/ticketTypes \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": null,
    "price": 0,
    "quantityAvailable": 0,
    "enableLimitQuantityPerAttendee": false,
    "quantityLimitPerAttendee": 0,
    "description": null,
    "enableShowTicketDescriptionOnEventName": false,
    "enableIsOnSale": false,
    "enableHostFees": false,
    "enableTransferable": false,
    "attendeeGroupPublicAccessCode": null,
    "attendeeGroups": null,
    "ticketRules": null,
    "priceIncludesPlatformFees": false,
    "hostFeePublicIds": null
  }'

Response

{
  "publicId": null,
  "name": null,
  "price": 0,
  "quantityAvailable": 0,
  "enableLimitQuantityPerAttendee": false,
  "quantityLimitPerAttendee": 0,
  "description": null,
  "enableShowTicketDescriptionOnEventName": false,
  "enableTransferable": false,
  "attendeeGroupPublicAccessCode": null,
  "attendeeGroups": null,
  "stripePriceId": null,
  "stripeProductId": null,
  "totalPrice": 0,
  "order": 0,
  "totalPriceOfHostFees": 0,
  "totalPriceOfPlatformFees": 0,
  "soldOut": false,
  "ticketRules": null,
  "id": 0,
  "enableIsOnSale": false,
  "enableHostFees": false,
  "quantitySold": 0,
  "hostFees": null,
  "platformFees": null
}

GET/api/v1/events/{eventId}/ticketTypes/{id}

Get ticket type details

Requires authentication

Parameters

eventIdinteger (int32)

required

idinteger (int32)

required

Response· TicketTypeDto

publicIdstringnullable

optional

namestringnullable

optional

priceinteger (int64)

optional

quantityAvailableinteger (int32)

optional

enableLimitQuantityPerAttendeeboolean

optional

quantityLimitPerAttendeeinteger (int32)

optional

descriptionstringnullable

optional

enableShowTicketDescriptionOnEventNameboolean

optional

GEThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/ticketTypes/{id}

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/ticketTypes/{id}"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/ticketTypes/{id}",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/events/{eventId}/ticketTypes/{id} \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "publicId": null,
  "name": null,
  "price": 0,
  "quantityAvailable": 0,
  "enableLimitQuantityPerAttendee": false,
  "quantityLimitPerAttendee": 0,
  "description": null,
  "enableShowTicketDescriptionOnEventName": false,
  "enableTransferable": false,
  "attendeeGroupPublicAccessCode": null,
  "attendeeGroups": null,
  "stripePriceId": null,
  "stripeProductId": null,
  "totalPrice": 0,
  "order": 0,
  "totalPriceOfHostFees": 0,
  "totalPriceOfPlatformFees": 0,
  "soldOut": false,
  "ticketRules": null,
  "id": 0,
  "enableIsOnSale": false,
  "enableHostFees": false,
  "quantitySold": 0,
  "hostFees": null,
  "platformFees": null
}

PUT/api/v1/events/{eventId}/ticketTypes/{id}

Update ticket type configuration

Requires authentication

Parameters

eventIdinteger (int32)

required

idinteger (int32)

required

Request Body

namestringnullable

optional

priceinteger (int64)

optional

quantityAvailableinteger (int32)

optional

enableLimitQuantityPerAttendeeboolean

optional

quantityLimitPerAttendeeinteger (int32)

optional

descriptionstringnullable

optional

enableShowTicketDescriptionOnEventNameboolean

optional

enableIsOnSaleboolean

optional

Response· TicketTypeDto

publicIdstringnullable

optional

namestringnullable

optional

priceinteger (int64)

optional

quantityAvailableinteger (int32)

optional

enableLimitQuantityPerAttendeeboolean

optional

quantityLimitPerAttendeeinteger (int32)

optional

descriptionstringnullable

optional

enableShowTicketDescriptionOnEventNameboolean

optional

PUThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/ticketTypes/{id}

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/ticketTypes/{id}"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "name": null,
  "price": 0,
  "quantityAvailable": 0,
  "enableLimitQuantityPerAttendee": false,
  "quantityLimitPerAttendee": 0,
  "description": null,
  "enableShowTicketDescriptionOnEventName": false,
  "enableIsOnSale": false,
  "enableHostFees": false,
  "enableTransferable": false,
  "attendeeGroupPublicAccessCode": null,
  "attendeeGroups": null,
  "ticketRules": null,
  "order": 0,
  "priceIncludesPlatformFees": false,
  "hostFeePublicIds": null
}

response = requests.put(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/ticketTypes/{id}",
  {
    method: "PUT",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": null,
      "price": 0,
      "quantityAvailable": 0,
      "enableLimitQuantityPerAttendee": false,
      "quantityLimitPerAttendee": 0,
      "description": null,
      "enableShowTicketDescriptionOnEventName": false,
      "enableIsOnSale": false,
      "enableHostFees": false,
      "enableTransferable": false,
      "attendeeGroupPublicAccessCode": null,
      "attendeeGroups": null,
      "ticketRules": null,
      "order": 0,
      "priceIncludesPlatformFees": false,
      "hostFeePublicIds": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X PUT https://dashboard.crowdpass.co/api/v1/events/{eventId}/ticketTypes/{id} \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": null,
    "price": 0,
    "quantityAvailable": 0,
    "enableLimitQuantityPerAttendee": false,
    "quantityLimitPerAttendee": 0,
    "description": null,
    "enableShowTicketDescriptionOnEventName": false,
    "enableIsOnSale": false,
    "enableHostFees": false,
    "enableTransferable": false,
    "attendeeGroupPublicAccessCode": null,
    "attendeeGroups": null,
    "ticketRules": null,
    "order": 0,
    "priceIncludesPlatformFees": false,
    "hostFeePublicIds": null
  }'

Response

{
  "publicId": null,
  "name": null,
  "price": 0,
  "quantityAvailable": 0,
  "enableLimitQuantityPerAttendee": false,
  "quantityLimitPerAttendee": 0,
  "description": null,
  "enableShowTicketDescriptionOnEventName": false,
  "enableTransferable": false,
  "attendeeGroupPublicAccessCode": null,
  "attendeeGroups": null,
  "stripePriceId": null,
  "stripeProductId": null,
  "totalPrice": 0,
  "order": 0,
  "totalPriceOfHostFees": 0,
  "totalPriceOfPlatformFees": 0,
  "soldOut": false,
  "ticketRules": null,
  "id": 0,
  "enableIsOnSale": false,
  "enableHostFees": false,
  "quantitySold": 0,
  "hostFees": null,
  "platformFees": null
}

DELETE/api/v1/events/{eventId}/ticketTypes/{id}

Delete a ticket type

Requires authentication

Parameters

eventIdinteger (int32)

required

idinteger (int32)

required

DELETEhttps://dashboard.crowdpass.co/api/v1/events/{eventId}/ticketTypes/{id}

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/ticketTypes/{id}"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.delete(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/ticketTypes/{id}",
  {
    method: "DELETE",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl -X DELETE https://dashboard.crowdpass.co/api/v1/events/{eventId}/ticketTypes/{id} \
  -H "Authorization: Bearer YOUR_TOKEN"

GET/api/v1/events/{eventId}/ticketing/dashboard

Get ticketing dashboard analytics

Requires authentication

Parameters

eventIdinteger (int32)

required

Returns TicketDto[]

GEThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/ticketing/dashboard

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/ticketing/dashboard"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/ticketing/dashboard",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/events/{eventId}/ticketing/dashboard \
  -H "Authorization: Bearer YOUR_TOKEN"

GET/api/v1/events/{eventId}/ticketing/transfers

List ticket transfer history

Requires authentication

Parameters

eventIdinteger (int32)

required

GEThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/ticketing/transfers

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/ticketing/transfers"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/ticketing/transfers",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/events/{eventId}/ticketing/transfers \
  -H "Authorization: Bearer YOUR_TOKEN"

DELETE/api/v1/tickets/{publicId}

Cancel a ticket by public ID

Requires authentication

Parameters

publicIdstring

required

DELETEhttps://dashboard.crowdpass.co/api/v1/tickets/{publicId}

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/tickets/{publicId}"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.delete(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/tickets/{publicId}",
  {
    method: "DELETE",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl -X DELETE https://dashboard.crowdpass.co/api/v1/tickets/{publicId} \
  -H "Authorization: Bearer YOUR_TOKEN"

Tickets

Ticket scanning, refunds, and transfers.

5 endpoints

POST/api/v1/ticket/scan/{checkInCode}

Scan ticket for check-in

Requires authentication

Parameters

checkInCodestring

required

gateIdinteger (int32)

optional

deviceNamestring

optional

Response· Ticket

idinteger (int32)

optional

isDeletedboolean

optional

deletedAtstring (date-time)nullable

optional

xmininteger (int32)

optional

createdByUserinteger (int32)

optional

createdDatestring (date-time)

optional

lastModifiedByUserinteger (int32)

optional

lastModifiedDatestring (date-time)

optional

POSThttps://dashboard.crowdpass.co/api/v1/ticket/scan/{checkInCode}

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/ticket/scan/{checkInCode}"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.post(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/ticket/scan/{checkInCode}",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/ticket/scan/{checkInCode} \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "id": 0,
  "isDeleted": false,
  "deletedAt": null,
  "xmin": 0,
  "createdByUser": 0,
  "createdDate": "2026-01-01T00:00:00Z",
  "lastModifiedByUser": 0,
  "lastModifiedDate": "2026-01-01T00:00:00Z",
  "ownedByAttendeeId": 0,
  "attendee": {},
  "orderItemId": 0,
  "orderItem": {},
  "publicId": null,
  "isScanned": false,
  "scannedDateTime": null,
  "transferredOut": false,
  "accessCode": null,
  "isHostGift": false,
  "ticketScans": null,
  "ticketTransfers": null,
  "isRefunded": false
}

POST/api/v1/ticket/scan/{checkInCode}/scan-out

Scan ticket for check-out

Requires authentication

Parameters

checkInCodestring

required

Response· Ticket

idinteger (int32)

optional

isDeletedboolean

optional

deletedAtstring (date-time)nullable

optional

xmininteger (int32)

optional

createdByUserinteger (int32)

optional

createdDatestring (date-time)

optional

lastModifiedByUserinteger (int32)

optional

lastModifiedDatestring (date-time)

optional

POSThttps://dashboard.crowdpass.co/api/v1/ticket/scan/{checkInCode}/scan-out

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/ticket/scan/{checkInCode}/scan-out"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.post(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/ticket/scan/{checkInCode}/scan-out",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/ticket/scan/{checkInCode}/scan-out \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "id": 0,
  "isDeleted": false,
  "deletedAt": null,
  "xmin": 0,
  "createdByUser": 0,
  "createdDate": "2026-01-01T00:00:00Z",
  "lastModifiedByUser": 0,
  "lastModifiedDate": "2026-01-01T00:00:00Z",
  "ownedByAttendeeId": 0,
  "attendee": {},
  "orderItemId": 0,
  "orderItem": {},
  "publicId": null,
  "isScanned": false,
  "scannedDateTime": null,
  "transferredOut": false,
  "accessCode": null,
  "isHostGift": false,
  "ticketScans": null,
  "ticketTransfers": null,
  "isRefunded": false
}

POST/api/v1/tickets/{ticketPublicId}/transfer

Transfer ticket to another attendee

Requires authentication

Parameters

ticketPublicIdstring

required

Request Body

emailstringnullable

optional

firstNamestringnullable

optional

lastNamestringnullable

optional

inviteToRegisterboolean

optional

phoneNumberstringnullable

optional

guestOfAttendeeIdinteger (int32)nullable

optional

POSThttps://dashboard.crowdpass.co/api/v1/tickets/{ticketPublicId}/transfer

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/tickets/{ticketPublicId}/transfer"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "email": null,
  "firstName": null,
  "lastName": null,
  "inviteToRegister": false,
  "phoneNumber": null,
  "guestOfAttendeeId": null
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/tickets/{ticketPublicId}/transfer",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "email": null,
      "firstName": null,
      "lastName": null,
      "inviteToRegister": false,
      "phoneNumber": null,
      "guestOfAttendeeId": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/tickets/{ticketPublicId}/transfer \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "email": null,
    "firstName": null,
    "lastName": null,
    "inviteToRegister": false,
    "phoneNumber": null,
    "guestOfAttendeeId": null
  }'

POST/api/v1/tickets/{ticketPublicId}/refund

Process ticket refund

Requires authentication

Parameters

ticketPublicIdstring

required

POSThttps://dashboard.crowdpass.co/api/v1/tickets/{ticketPublicId}/refund

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/tickets/{ticketPublicId}/refund"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.post(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/tickets/{ticketPublicId}/refund",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/tickets/{ticketPublicId}/refund \
  -H "Authorization: Bearer YOUR_TOKEN"

GET/api/public/tickets/qr-code/{accessCode}

Get ticket QR code by access code

Parameters

accessCodestring

required

GEThttps://dashboard.crowdpass.co/api/public/tickets/qr-code/{accessCode}

Request

import requests

url = "https://dashboard.crowdpass.co/api/public/tickets/qr-code/{accessCode}"

response = requests.get(url)
print(response.json())

const response = await fetch("https://dashboard.crowdpass.co/api/public/tickets/qr-code/{accessCode}");
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/public/tickets/qr-code/{accessCode}

Fees

Fee structures and pricing rules for events.

2 endpoints

GET/api/public/fees/{publicId}

Get public fee details

Parameters

publicIdstring

required

Response· PublicFeeDto

namestringnullable

optional

descriptionstringnullable

optional

feeAmountnumber (double)nullable

optional

feeTypeFeeType

optional

publicIdstringnullable

optional

GEThttps://dashboard.crowdpass.co/api/public/fees/{publicId}

Request

import requests

url = "https://dashboard.crowdpass.co/api/public/fees/{publicId}"

response = requests.get(url)
print(response.json())

const response = await fetch("https://dashboard.crowdpass.co/api/public/fees/{publicId}");
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/public/fees/{publicId}

Response

{
  "name": null,
  "description": null,
  "feeAmount": null,
  "feeType": {},
  "publicId": null
}

POST/api/v1/fees/companies/current

Create fee for current company

Requires authentication

Request Body

namestringnullable

optional

descriptionstringnullable

optional

feeAmountnumber (double)nullable

optional

feeTypeFeeType

optional

Response· FeeDto

namestringnullable

optional

descriptionstringnullable

optional

feeAmountnumber (double)nullable

optional

feeTypeFeeType

optional

idinteger (int32)

optional

publicIdstringnullable

optional

POSThttps://dashboard.crowdpass.co/api/v1/fees/companies/current

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/fees/companies/current"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "name": null,
  "description": null,
  "feeAmount": null,
  "feeType": {}
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/fees/companies/current",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": null,
      "description": null,
      "feeAmount": null,
      "feeType": {}
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/fees/companies/current \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": null,
    "description": null,
    "feeAmount": null,
    "feeType": {}
  }'

Response

{
  "name": null,
  "description": null,
  "feeAmount": null,
  "feeType": {},
  "id": 0,
  "publicId": null
}

Communication

SMS

SMS notification delivery, dashboard analytics, and checkout.

7 endpoints

POST/api/public/twilio/webhook

Receive Twilio SMS webhook

POSThttps://dashboard.crowdpass.co/api/public/twilio/webhook

Request

import requests

url = "https://dashboard.crowdpass.co/api/public/twilio/webhook"

response = requests.post(url)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/public/twilio/webhook",
  {
    method: "POST",
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/public/twilio/webhook

GET/api/v1/sms/numbers

List available SMS phone numbers

Requires authentication

Parameters

areaCodeinteger (int32)

required

Response· TwilioPhoneNumberDto

phoneNumberstringnullable

optional

friendlyNamestringnullable

optional

isoCountrystringnullable

optional

GEThttps://dashboard.crowdpass.co/api/v1/sms/numbers

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/sms/numbers"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/sms/numbers",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/sms/numbers \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "phoneNumber": null,
  "friendlyName": null,
  "isoCountry": null
}

GET/api/v1/sms/{eventId}/dashboard

Get SMS dashboard for event

Requires authentication

Parameters

eventIdinteger (int32)

required

pageSizeinteger (int32)

required

currentPageinteger (int32)

required

Response· TwilioPhoneNumberDto

phoneNumberstringnullable

optional

friendlyNamestringnullable

optional

isoCountrystringnullable

optional

GEThttps://dashboard.crowdpass.co/api/v1/sms/{eventId}/dashboard

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/sms/{eventId}/dashboard"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/sms/{eventId}/dashboard",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/sms/{eventId}/dashboard \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "phoneNumber": null,
  "friendlyName": null,
  "isoCountry": null
}

POST/api/v1/sms/cancel

Cancel a pending SMS

Requires authentication

Request Body

messageSidstringnullable

optional

Response· BooleanCommandResult

statusFeatureResultStatus

optional

dataobjectnullable

optional

messagestringnullable

optional

POSThttps://dashboard.crowdpass.co/api/v1/sms/cancel

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/sms/cancel"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "messageSid": null
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/sms/cancel",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "messageSid": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/sms/cancel \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "messageSid": null
  }'

Response

{
  "status": {},
  "data": null,
  "message": null
}

POST/api/v1/sms/calculate-pricing

Calculate SMS campaign pricing

Requires authentication

Request Body

eventIdinteger (int32)

optional

attendeeIdsinteger[]nullable

optional

channelstringnullable

optional

Response· SmsPricingResultDtoCommandResult

statusFeatureResultStatus

optional

dataobjectnullable

optional

messagestringnullable

optional

POSThttps://dashboard.crowdpass.co/api/v1/sms/calculate-pricing

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/sms/calculate-pricing"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "eventId": 0,
  "attendeeIds": null,
  "channel": null
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/sms/calculate-pricing",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "eventId": 0,
      "attendeeIds": null,
      "channel": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/sms/calculate-pricing \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "eventId": 0,
    "attendeeIds": null,
    "channel": null
  }'

Response

{
  "status": {},
  "data": null,
  "message": null
}

POST/api/v1/sms/checkout

Start SMS credits checkout

Requires authentication

Request Body

eventIdinteger (int32)

optional

messagestringnullable

optional

attendeeIdsinteger[]nullable

optional

deliveryDatestring (date-time)nullable

optional

smsCampaignIdinteger (int32)nullable

optional

channelstringnullable

optional

Response· SmsCheckoutResultDtoCommandResult

statusFeatureResultStatus

optional

dataobjectnullable

optional

messagestringnullable

optional

POSThttps://dashboard.crowdpass.co/api/v1/sms/checkout

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/sms/checkout"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "eventId": 0,
  "message": null,
  "attendeeIds": null,
  "deliveryDate": null,
  "smsCampaignId": null,
  "channel": null
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/sms/checkout",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "eventId": 0,
      "message": null,
      "attendeeIds": null,
      "deliveryDate": null,
      "smsCampaignId": null,
      "channel": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/sms/checkout \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "eventId": 0,
    "message": null,
    "attendeeIds": null,
    "deliveryDate": null,
    "smsCampaignId": null,
    "channel": null
  }'

Response

{
  "status": {},
  "data": null,
  "message": null
}

POST/api/v1/sms/checkout/complete

Complete SMS credits checkout

Requires authentication

Request Body

sessionIdstringnullable

optional

eventIdstringnullable

optional

Response· CommandResult

statusFeatureResultStatus

optional

dataobjectnullable

optional

messagestringnullable

optional

POSThttps://dashboard.crowdpass.co/api/v1/sms/checkout/complete

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/sms/checkout/complete"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "sessionId": null,
  "eventId": null
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/sms/checkout/complete",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "sessionId": null,
      "eventId": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/sms/checkout/complete \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "sessionId": null,
    "eventId": null
  }'

Response

{
  "status": {},
  "data": null,
  "message": null
}

SMS Campaigns

SMS campaign management and scheduling.

4 endpoints

GET/api/v1/sms-campaigns

List all SMS campaigns

Requires authentication

Parameters

currentPageinteger (int32)

optional

pageSizeinteger (int32)

optional

Response· SmsCampaignDtoListQueryResultSlim

statusFeatureResultStatus

optional

dataobjectnullable

optional

messagestringnullable

optional

totalItemCountinteger (int32)

optional

GEThttps://dashboard.crowdpass.co/api/v1/sms-campaigns

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/sms-campaigns"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/sms-campaigns",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/sms-campaigns \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "status": {},
  "data": null,
  "message": null,
  "totalItemCount": 0
}

POST/api/v1/sms-campaigns

Create a new SMS campaign

Requires authentication

Request Body

campaignNamestringnullable

optional

campaignDescriptionstringnullable

optional

Response· SmsCampaignDtoCommandResult

statusFeatureResultStatus

optional

dataobjectnullable

optional

messagestringnullable

optional

POSThttps://dashboard.crowdpass.co/api/v1/sms-campaigns

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/sms-campaigns"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "campaignName": null,
  "campaignDescription": null
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/sms-campaigns",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "campaignName": null,
      "campaignDescription": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/sms-campaigns \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "campaignName": null,
    "campaignDescription": null
  }'

Response

{
  "status": {},
  "data": null,
  "message": null
}

PUT/api/v1/sms-campaigns/{smsCampaignId}

Update an SMS campaign

Requires authentication

Parameters

smsCampaignIdinteger (int32)

required

Request Body

idinteger (int32)

optional

campaignNamestringnullable

optional

campaignDescriptionstringnullable

optional

Response· SmsCampaignDtoCommandResult

statusFeatureResultStatus

optional

dataobjectnullable

optional

messagestringnullable

optional

PUThttps://dashboard.crowdpass.co/api/v1/sms-campaigns/{smsCampaignId}

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/sms-campaigns/{smsCampaignId}"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "id": 0,
  "campaignName": null,
  "campaignDescription": null
}

response = requests.put(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/sms-campaigns/{smsCampaignId}",
  {
    method: "PUT",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": 0,
      "campaignName": null,
      "campaignDescription": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X PUT https://dashboard.crowdpass.co/api/v1/sms-campaigns/{smsCampaignId} \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "id": 0,
    "campaignName": null,
    "campaignDescription": null
  }'

Response

{
  "status": {},
  "data": null,
  "message": null
}

DELETE/api/v1/sms-campaigns/{smsCampaignId}

Delete an SMS campaign

Requires authentication

Parameters

smsCampaignIdinteger (int32)

required

Response· CommandResult

statusFeatureResultStatus

optional

dataobjectnullable

optional

messagestringnullable

optional

DELETEhttps://dashboard.crowdpass.co/api/v1/sms-campaigns/{smsCampaignId}

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/sms-campaigns/{smsCampaignId}"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.delete(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/sms-campaigns/{smsCampaignId}",
  {
    method: "DELETE",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl -X DELETE https://dashboard.crowdpass.co/api/v1/sms-campaigns/{smsCampaignId} \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "status": {},
  "data": null,
  "message": null
}

Email

Email delivery dashboard and analytics.

1 endpoint

GET/api/v1/email/{eventId}/dashboard

Get email dashboard for event

Requires authentication

Parameters

eventIdinteger (int32)

required

pageSizeinteger (int32)

required

currentPageinteger (int32)

required

Response· EmailDeliveryResult

itemsEmailDeliveryStatusDto[]nullable

optional

totalSuccessinteger (int32)

optional

totalSendsinteger (int32)

optional

totalItemCountinteger (int32)

optional

GEThttps://dashboard.crowdpass.co/api/v1/email/{eventId}/dashboard

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/email/{eventId}/dashboard"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/email/{eventId}/dashboard",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/email/{eventId}/dashboard \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "items": null,
  "totalSuccess": 0,
  "totalSends": 0,
  "totalItemCount": 0
}

Email Templates

Reusable email template management with versioning and category support.

12 endpoints

GET/api/v1/email-templates

List all email templates

Requires authentication

Parameters

currentPageinteger (int32)

optional

pageSizeinteger (int32)

optional

isDefaultboolean

optional

categoryIdinteger (int32)

optional

eventIdinteger (int32)

optional

Response· EmailTemplateDtoListQueryResultSlim

statusFeatureResultStatus

optional

dataobjectnullable

optional

messagestringnullable

optional

totalItemCountinteger (int32)

optional

GEThttps://dashboard.crowdpass.co/api/v1/email-templates

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/email-templates"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/email-templates",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/email-templates \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "status": {},
  "data": null,
  "message": null,
  "totalItemCount": 0
}

POST/api/v1/email-templates

Create a new email template

Requires authentication

Request Body

projectDatastringnullable

optional

subjectstringnullable

optional

htmlBodystringnullable

optional

isDefaultboolean

optional

categoryIdinteger (int32)nullable

optional

eventIdinteger (int32)nullable

optional

categoryEmailTemplateCategoryDto

optional

Response· EmailTemplateDtoCommandResult

statusFeatureResultStatus

optional

dataobjectnullable

optional

messagestringnullable

optional

POSThttps://dashboard.crowdpass.co/api/v1/email-templates

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/email-templates"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "projectData": null,
  "subject": null,
  "htmlBody": null,
  "isDefault": false,
  "categoryId": null,
  "eventId": null,
  "category": {}
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/email-templates",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "projectData": null,
      "subject": null,
      "htmlBody": null,
      "isDefault": false,
      "categoryId": null,
      "eventId": null,
      "category": {}
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/email-templates \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "projectData": null,
    "subject": null,
    "htmlBody": null,
    "isDefault": false,
    "categoryId": null,
    "eventId": null,
    "category": {}
  }'

Response

{
  "status": {},
  "data": null,
  "message": null
}

GET/api/v1/email-templates/{id}

Get email template details

Requires authentication

Parameters

idinteger (int32)

required

Response· EmailTemplateDtoQueryResult

statusFeatureResultStatus

optional

dataobjectnullable

optional

messagestringnullable

optional

GEThttps://dashboard.crowdpass.co/api/v1/email-templates/{id}

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/email-templates/{id}"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/email-templates/{id}",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/email-templates/{id} \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "status": {},
  "data": null,
  "message": null
}

PUT/api/v1/email-templates/{id}

Update email template

Requires authentication

Parameters

idinteger (int32)

required

Request Body

projectDatastringnullable

optional

subjectstringnullable

optional

htmlBodystringnullable

optional

originalTemplateIdinteger (int32)

optional

isDefaultboolean

optional

categoryIdinteger (int32)nullable

optional

Response· EmailTemplateDtoCommandResult

statusFeatureResultStatus

optional

dataobjectnullable

optional

messagestringnullable

optional

PUThttps://dashboard.crowdpass.co/api/v1/email-templates/{id}

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/email-templates/{id}"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "projectData": null,
  "subject": null,
  "htmlBody": null,
  "originalTemplateId": 0,
  "isDefault": false,
  "categoryId": null
}

response = requests.put(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/email-templates/{id}",
  {
    method: "PUT",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "projectData": null,
      "subject": null,
      "htmlBody": null,
      "originalTemplateId": 0,
      "isDefault": false,
      "categoryId": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X PUT https://dashboard.crowdpass.co/api/v1/email-templates/{id} \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "projectData": null,
    "subject": null,
    "htmlBody": null,
    "originalTemplateId": 0,
    "isDefault": false,
    "categoryId": null
  }'

Response

{
  "status": {},
  "data": null,
  "message": null
}

DELETE/api/v1/email-templates/{id}

Delete email template

Requires authentication

Parameters

idinteger (int32)

required

Response· CommandResult

statusFeatureResultStatus

optional

dataobjectnullable

optional

messagestringnullable

optional

DELETEhttps://dashboard.crowdpass.co/api/v1/email-templates/{id}

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/email-templates/{id}"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.delete(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/email-templates/{id}",
  {
    method: "DELETE",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl -X DELETE https://dashboard.crowdpass.co/api/v1/email-templates/{id} \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "status": {},
  "data": null,
  "message": null
}

GET/api/v1/events/{eventId}/email-templates

List email templates for event

Requires authentication

Parameters

eventIdinteger (int32)

required

currentPageinteger (int32)

optional

pageSizeinteger (int32)

optional

isDefaultboolean

optional

categoryIdinteger (int32)

optional

Response· EmailTemplateDtoListQueryResultSlim

statusFeatureResultStatus

optional

dataobjectnullable

optional

messagestringnullable

optional

totalItemCountinteger (int32)

optional

GEThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/email-templates

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/email-templates"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/email-templates",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/events/{eventId}/email-templates \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "status": {},
  "data": null,
  "message": null,
  "totalItemCount": 0
}

GET/api/v1/email-templates/{originalTemplateId}/versions

List template versions

Requires authentication

Parameters

originalTemplateIdinteger (int32)

required

Response· EmailTemplateDtoListQueryResultSlim

statusFeatureResultStatus

optional

dataobjectnullable

optional

messagestringnullable

optional

totalItemCountinteger (int32)

optional

GEThttps://dashboard.crowdpass.co/api/v1/email-templates/{originalTemplateId}/versions

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/email-templates/{originalTemplateId}/versions"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/email-templates/{originalTemplateId}/versions",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/email-templates/{originalTemplateId}/versions \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "status": {},
  "data": null,
  "message": null,
  "totalItemCount": 0
}

GET/api/v1/email-templates/categories

List email template categories

Requires authentication

Response· EmailTemplateCategoryListQueryResult

statusFeatureResultStatus

optional

dataobjectnullable

optional

messagestringnullable

optional

GEThttps://dashboard.crowdpass.co/api/v1/email-templates/categories

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/email-templates/categories"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/email-templates/categories",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/email-templates/categories \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "status": {},
  "data": null,
  "message": null
}

GET/api/v1/email-templates/{eventId}/connections

Get template connections for event

Requires authentication

Parameters

eventIdinteger (int32)

required

Response· GetConnectionsDtoListQueryResult

statusFeatureResultStatus

optional

dataobjectnullable

optional

messagestringnullable

optional

GEThttps://dashboard.crowdpass.co/api/v1/email-templates/{eventId}/connections

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/email-templates/{eventId}/connections"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/email-templates/{eventId}/connections",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/email-templates/{eventId}/connections \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "status": {},
  "data": null,
  "message": null
}

PATCH/api/v1/email-templates/connections

Update email template connections

Requires authentication

Request Body

actionstringnullable

optional

eventIdinteger (int32)

optional

templateIdinteger (int32)

optional

newTemplateIdinteger (int32)nullable

optional

PATCHhttps://dashboard.crowdpass.co/api/v1/email-templates/connections

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/email-templates/connections"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "action": null,
  "eventId": 0,
  "templateId": 0,
  "newTemplateId": null
}

response = requests.patch(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/email-templates/connections",
  {
    method: "PATCH",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "action": null,
      "eventId": 0,
      "templateId": 0,
      "newTemplateId": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X PATCH https://dashboard.crowdpass.co/api/v1/email-templates/connections \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "action": null,
    "eventId": 0,
    "templateId": 0,
    "newTemplateId": null
  }'

GET/api/v1/events/{eventId}/email-templates/categories/check

Check template category availability

Requires authentication

Parameters

eventIdinteger (int32)

required

Response· CategoryTemplateExistenceDtoListQueryResult

statusFeatureResultStatus

optional

dataobjectnullable

optional

messagestringnullable

optional

GEThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/email-templates/categories/check

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/email-templates/categories/check"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/email-templates/categories/check",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/events/{eventId}/email-templates/categories/check \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "status": {},
  "data": null,
  "message": null
}

POST/api/v1/email-templates/send/{originalTemplateId}

Send email using template

Requires authentication

Parameters

originalTemplateIdinteger (int32)

required

Request Body

eventIdinteger (int32)

optional

attendeeIdsinteger[]nullable

optional

Response· BooleanCommandResult

statusFeatureResultStatus

optional

dataobjectnullable

optional

messagestringnullable

optional

POSThttps://dashboard.crowdpass.co/api/v1/email-templates/send/{originalTemplateId}

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/email-templates/send/{originalTemplateId}"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "eventId": 0,
  "attendeeIds": null
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/email-templates/send/{originalTemplateId}",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "eventId": 0,
      "attendeeIds": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/email-templates/send/{originalTemplateId} \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "eventId": 0,
    "attendeeIds": null
  }'

Response

{
  "status": {},
  "data": null,
  "message": null
}

Content

Badges

Badge template design, generation, and printing.

5 endpoints

POST/api/v1/badge

Create a new badge template

Requires authentication

Parameters

groupIdinteger (int32)

optional

Request Body

eventIdinteger (int32)

optional

itemsJsonstringnullable

optional

widthInchesnumber (double)

optional

heightInchesnumber (double)

optional

backgroundBlobIdinteger (int32)nullable

optional

backgroundColorstringnullable

optional

customImagesBlobIdsinteger[]nullable

optional

attendeeGroupIdinteger (int32)

optional

Response· BadgeDto

eventIdinteger (int32)

optional

itemsJsonstringnullable

optional

widthInchesnumber (double)

optional

heightInchesnumber (double)

optional

backgroundBlobIdinteger (int32)nullable

optional

backgroundColorstringnullable

optional

customImagesBlobIdsinteger[]nullable

optional

attendeeGroupIdinteger (int32)

optional

POSThttps://dashboard.crowdpass.co/api/v1/badge

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/badge"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "eventId": 0,
  "itemsJson": null,
  "widthInches": 0,
  "heightInches": 0,
  "backgroundBlobId": null,
  "backgroundColor": null,
  "customImagesBlobIds": null,
  "attendeeGroupId": 0
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/badge",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "eventId": 0,
      "itemsJson": null,
      "widthInches": 0,
      "heightInches": 0,
      "backgroundBlobId": null,
      "backgroundColor": null,
      "customImagesBlobIds": null,
      "attendeeGroupId": 0
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/badge \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "eventId": 0,
    "itemsJson": null,
    "widthInches": 0,
    "heightInches": 0,
    "backgroundBlobId": null,
    "backgroundColor": null,
    "customImagesBlobIds": null,
    "attendeeGroupId": 0
  }'

Response

{
  "eventId": 0,
  "itemsJson": null,
  "widthInches": 0,
  "heightInches": 0,
  "backgroundBlobId": null,
  "backgroundColor": null,
  "customImagesBlobIds": null,
  "attendeeGroupId": 0,
  "id": 0
}

PUT/api/v1/badge

Update badge template

Requires authentication

Request Body

eventIdinteger (int32)

optional

itemsJsonstringnullable

optional

widthInchesnumber (double)

optional

heightInchesnumber (double)

optional

backgroundBlobIdinteger (int32)nullable

optional

backgroundColorstringnullable

optional

customImagesBlobIdsinteger[]nullable

optional

attendeeGroupIdinteger (int32)

optional

Response· BadgeDto

eventIdinteger (int32)

optional

itemsJsonstringnullable

optional

widthInchesnumber (double)

optional

heightInchesnumber (double)

optional

backgroundBlobIdinteger (int32)nullable

optional

backgroundColorstringnullable

optional

customImagesBlobIdsinteger[]nullable

optional

attendeeGroupIdinteger (int32)

optional

PUThttps://dashboard.crowdpass.co/api/v1/badge

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/badge"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "eventId": 0,
  "itemsJson": null,
  "widthInches": 0,
  "heightInches": 0,
  "backgroundBlobId": null,
  "backgroundColor": null,
  "customImagesBlobIds": null,
  "attendeeGroupId": 0,
  "id": 0
}

response = requests.put(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/badge",
  {
    method: "PUT",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "eventId": 0,
      "itemsJson": null,
      "widthInches": 0,
      "heightInches": 0,
      "backgroundBlobId": null,
      "backgroundColor": null,
      "customImagesBlobIds": null,
      "attendeeGroupId": 0,
      "id": 0
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X PUT https://dashboard.crowdpass.co/api/v1/badge \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "eventId": 0,
    "itemsJson": null,
    "widthInches": 0,
    "heightInches": 0,
    "backgroundBlobId": null,
    "backgroundColor": null,
    "customImagesBlobIds": null,
    "attendeeGroupId": 0,
    "id": 0
  }'

Response

{
  "eventId": 0,
  "itemsJson": null,
  "widthInches": 0,
  "heightInches": 0,
  "backgroundBlobId": null,
  "backgroundColor": null,
  "customImagesBlobIds": null,
  "attendeeGroupId": 0,
  "id": 0
}

GET/api/v1/events/{eventId}/badge

Get badge template for event

Requires authentication

Parameters

eventIdinteger (int32)

required

groupIdinteger (int32)

optional

Response· BadgeDto

eventIdinteger (int32)

optional

itemsJsonstringnullable

optional

widthInchesnumber (double)

optional

heightInchesnumber (double)

optional

backgroundBlobIdinteger (int32)nullable

optional

backgroundColorstringnullable

optional

customImagesBlobIdsinteger[]nullable

optional

attendeeGroupIdinteger (int32)

optional

GEThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/badge

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/badge"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/badge",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/events/{eventId}/badge \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "eventId": 0,
  "itemsJson": null,
  "widthInches": 0,
  "heightInches": 0,
  "backgroundBlobId": null,
  "backgroundColor": null,
  "customImagesBlobIds": null,
  "attendeeGroupId": 0,
  "id": 0
}

GET/api/v1/events/{eventId}/badge/all

List all badge templates for event

Requires authentication

Parameters

eventIdinteger (int32)

required

Response· BadgeDto

eventIdinteger (int32)

optional

itemsJsonstringnullable

optional

widthInchesnumber (double)

optional

heightInchesnumber (double)

optional

backgroundBlobIdinteger (int32)nullable

optional

backgroundColorstringnullable

optional

customImagesBlobIdsinteger[]nullable

optional

attendeeGroupIdinteger (int32)

optional

GEThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/badge/all

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/badge/all"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/badge/all",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/events/{eventId}/badge/all \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "eventId": 0,
  "itemsJson": null,
  "widthInches": 0,
  "heightInches": 0,
  "backgroundBlobId": null,
  "backgroundColor": null,
  "customImagesBlobIds": null,
  "attendeeGroupId": 0,
  "id": 0
}

POST/api/v1/badge/print

Send badge to print queue

Requires authentication

POSThttps://dashboard.crowdpass.co/api/v1/badge/print

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/badge/print"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.post(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/badge/print",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/badge/print \
  -H "Authorization: Bearer YOUR_TOKEN"

Crowdpages

Public event landing page builder with analytics and QR code support.

16 endpoints

POST/api/v1/events/checkSlug

Check if event slug is available

Requires authentication

Request Body

slugstringnullable

optional

POSThttps://dashboard.crowdpass.co/api/v1/events/checkSlug

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/checkSlug"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "slug": null
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/checkSlug",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "slug": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/events/checkSlug \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "slug": null
  }'

POST/api/public/crowdpages/{publicId}/submit

Submit crowdpage form

Parameters

publicIdstring

required

Request Body

answersCrowdpageAnswerDto[]nullable

optional

publicIdstringnullable

optional

POSThttps://dashboard.crowdpass.co/api/public/crowdpages/{publicId}/submit

Request

import requests

url = "https://dashboard.crowdpass.co/api/public/crowdpages/{publicId}/submit"
payload = {
  "answers": null,
  "publicId": null
}

response = requests.post(url, json=payload)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/public/crowdpages/{publicId}/submit",
  {
    method: "POST",
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "answers": null,
      "publicId": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/public/crowdpages/{publicId}/submit \
  -H "Content-Type: application/json" \
  -d '{
    "answers": null,
    "publicId": null
  }'

GET/api/public/crowdpages/{slug}

Get public crowdpage by URL slug

Parameters

slugstring

required

Response· CrowdpageDto

titlestringnullable

optional

descriptionstringnullable

optional

liveboolean

optional

favIconBlobIdinteger (int32)nullable

optional

favIconBlobReferenceKeystringnullable

optional

shortCutIconBlobIdinteger (int32)nullable

optional

shortCutIconBlobReferenceKeystringnullable

optional

openGraphImageBlobIdinteger (int32)nullable

optional

GEThttps://dashboard.crowdpass.co/api/public/crowdpages/{slug}

Request

import requests

url = "https://dashboard.crowdpass.co/api/public/crowdpages/{slug}"

response = requests.get(url)
print(response.json())

const response = await fetch("https://dashboard.crowdpass.co/api/public/crowdpages/{slug}");
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/public/crowdpages/{slug}

Response

{
  "title": null,
  "description": null,
  "live": false,
  "favIconBlobId": null,
  "favIconBlobReferenceKey": null,
  "shortCutIconBlobId": null,
  "shortCutIconBlobReferenceKey": null,
  "openGraphImageBlobId": null,
  "openGraphImageBlobReferenceKey": null,
  "metaPixelId": null,
  "googleAnalyticsId": null,
  "onSubmitUrl": null,
  "slug": null,
  "externalUrl": null,
  "html": null,
  "style": null,
  "projectData": null,
  "layloEnabled": false,
  "layloToken": null,
  "pollingQuestions": null,
  "fontFamilies": null,
  "qrCodeBlobId": null,
  "lastDesignedAt": null,
  "lastViewedAt": null,
  "lastScannedAt": null,
  "publicId": null,
  "id": 0,
  "viewCount": 0,
  "scanCount": 0,
  "submissions": null,
  "questions": null
}

GET/api/public/crowdpages/qr/{publicId}

Get crowdpage QR code

Parameters

publicIdstring

required

Response· CrowdpageDto

titlestringnullable

optional

descriptionstringnullable

optional

liveboolean

optional

favIconBlobIdinteger (int32)nullable

optional

favIconBlobReferenceKeystringnullable

optional

shortCutIconBlobIdinteger (int32)nullable

optional

shortCutIconBlobReferenceKeystringnullable

optional

openGraphImageBlobIdinteger (int32)nullable

optional

GEThttps://dashboard.crowdpass.co/api/public/crowdpages/qr/{publicId}

Request

import requests

url = "https://dashboard.crowdpass.co/api/public/crowdpages/qr/{publicId}"

response = requests.get(url)
print(response.json())

const response = await fetch("https://dashboard.crowdpass.co/api/public/crowdpages/qr/{publicId}");
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/public/crowdpages/qr/{publicId}

Response

{
  "title": null,
  "description": null,
  "live": false,
  "favIconBlobId": null,
  "favIconBlobReferenceKey": null,
  "shortCutIconBlobId": null,
  "shortCutIconBlobReferenceKey": null,
  "openGraphImageBlobId": null,
  "openGraphImageBlobReferenceKey": null,
  "metaPixelId": null,
  "googleAnalyticsId": null,
  "onSubmitUrl": null,
  "slug": null,
  "externalUrl": null,
  "html": null,
  "style": null,
  "projectData": null,
  "layloEnabled": false,
  "layloToken": null,
  "pollingQuestions": null,
  "fontFamilies": null,
  "qrCodeBlobId": null,
  "lastDesignedAt": null,
  "lastViewedAt": null,
  "lastScannedAt": null,
  "publicId": null,
  "id": 0,
  "viewCount": 0,
  "scanCount": 0,
  "submissions": null,
  "questions": null
}

POST/api/public/crowdpages/{publicId}/view

Record crowdpage view

Parameters

publicIdstring

required

Request Body

devicestringnullable

optional

deviceTypestringnullable

optional

browserstringnullable

optional

ipAddressstringnullable

optional

regionstringnullable

optional

countrystringnullable

optional

citystringnullable

optional

POSThttps://dashboard.crowdpass.co/api/public/crowdpages/{publicId}/view

Request

import requests

url = "https://dashboard.crowdpass.co/api/public/crowdpages/{publicId}/view"
payload = {
  "device": null,
  "deviceType": null,
  "browser": null,
  "ipAddress": null,
  "region": null,
  "country": null,
  "city": null
}

response = requests.post(url, json=payload)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/public/crowdpages/{publicId}/view",
  {
    method: "POST",
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "device": null,
      "deviceType": null,
      "browser": null,
      "ipAddress": null,
      "region": null,
      "country": null,
      "city": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/public/crowdpages/{publicId}/view \
  -H "Content-Type: application/json" \
  -d '{
    "device": null,
    "deviceType": null,
    "browser": null,
    "ipAddress": null,
    "region": null,
    "country": null,
    "city": null
  }'

POST/api/public/crowdpages/{publicId}/scan

Record crowdpage QR scan

Parameters

publicIdstring

required

Request Body

devicestringnullable

optional

deviceTypestringnullable

optional

browserstringnullable

optional

ipAddressstringnullable

optional

regionstringnullable

optional

countrystringnullable

optional

citystringnullable

optional

POSThttps://dashboard.crowdpass.co/api/public/crowdpages/{publicId}/scan

Request

import requests

url = "https://dashboard.crowdpass.co/api/public/crowdpages/{publicId}/scan"
payload = {
  "device": null,
  "deviceType": null,
  "browser": null,
  "ipAddress": null,
  "region": null,
  "country": null,
  "city": null
}

response = requests.post(url, json=payload)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/public/crowdpages/{publicId}/scan",
  {
    method: "POST",
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "device": null,
      "deviceType": null,
      "browser": null,
      "ipAddress": null,
      "region": null,
      "country": null,
      "city": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/public/crowdpages/{publicId}/scan \
  -H "Content-Type: application/json" \
  -d '{
    "device": null,
    "deviceType": null,
    "browser": null,
    "ipAddress": null,
    "region": null,
    "country": null,
    "city": null
  }'

POST/api/public/crowdpages/submit/polling

Submit crowdpage polling response

Request Body

answerIdinteger (int32)

optional

devicestringnullable

optional

deviceTypestringnullable

optional

browserstringnullable

optional

ipAddressstringnullable

optional

regionstringnullable

optional

countrystringnullable

optional

citystringnullable

optional

POSThttps://dashboard.crowdpass.co/api/public/crowdpages/submit/polling

Request

import requests

url = "https://dashboard.crowdpass.co/api/public/crowdpages/submit/polling"
payload = {
  "answerId": 0,
  "device": null,
  "deviceType": null,
  "browser": null,
  "ipAddress": null,
  "region": null,
  "country": null,
  "city": null
}

response = requests.post(url, json=payload)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/public/crowdpages/submit/polling",
  {
    method: "POST",
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "answerId": 0,
      "device": null,
      "deviceType": null,
      "browser": null,
      "ipAddress": null,
      "region": null,
      "country": null,
      "city": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/public/crowdpages/submit/polling \
  -H "Content-Type: application/json" \
  -d '{
    "answerId": 0,
    "device": null,
    "deviceType": null,
    "browser": null,
    "ipAddress": null,
    "region": null,
    "country": null,
    "city": null
  }'

POST/api/v1/crowdpages

Create a new crowdpage

Requires authentication

Request Body

titlestringnullable

optional

descriptionstringnullable

optional

liveboolean

optional

favIconBlobIdinteger (int32)nullable

optional

favIconBlobReferenceKeystringnullable

optional

shortCutIconBlobIdinteger (int32)nullable

optional

shortCutIconBlobReferenceKeystringnullable

optional

openGraphImageBlobIdinteger (int32)nullable

optional

Response· CrowdpageDto

titlestringnullable

optional

descriptionstringnullable

optional

liveboolean

optional

favIconBlobIdinteger (int32)nullable

optional

favIconBlobReferenceKeystringnullable

optional

shortCutIconBlobIdinteger (int32)nullable

optional

shortCutIconBlobReferenceKeystringnullable

optional

openGraphImageBlobIdinteger (int32)nullable

optional

POSThttps://dashboard.crowdpass.co/api/v1/crowdpages

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/crowdpages"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "title": null,
  "description": null,
  "live": false,
  "favIconBlobId": null,
  "favIconBlobReferenceKey": null,
  "shortCutIconBlobId": null,
  "shortCutIconBlobReferenceKey": null,
  "openGraphImageBlobId": null,
  "openGraphImageBlobReferenceKey": null,
  "metaPixelId": null,
  "googleAnalyticsId": null,
  "onSubmitUrl": null,
  "slug": null,
  "externalUrl": null,
  "html": null,
  "style": null,
  "projectData": null,
  "layloEnabled": false,
  "layloToken": null,
  "pollingQuestions": null,
  "fontFamilies": null
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/crowdpages",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "title": null,
      "description": null,
      "live": false,
      "favIconBlobId": null,
      "favIconBlobReferenceKey": null,
      "shortCutIconBlobId": null,
      "shortCutIconBlobReferenceKey": null,
      "openGraphImageBlobId": null,
      "openGraphImageBlobReferenceKey": null,
      "metaPixelId": null,
      "googleAnalyticsId": null,
      "onSubmitUrl": null,
      "slug": null,
      "externalUrl": null,
      "html": null,
      "style": null,
      "projectData": null,
      "layloEnabled": false,
      "layloToken": null,
      "pollingQuestions": null,
      "fontFamilies": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/crowdpages \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "title": null,
    "description": null,
    "live": false,
    "favIconBlobId": null,
    "favIconBlobReferenceKey": null,
    "shortCutIconBlobId": null,
    "shortCutIconBlobReferenceKey": null,
    "openGraphImageBlobId": null,
    "openGraphImageBlobReferenceKey": null,
    "metaPixelId": null,
    "googleAnalyticsId": null,
    "onSubmitUrl": null,
    "slug": null,
    "externalUrl": null,
    "html": null,
    "style": null,
    "projectData": null,
    "layloEnabled": false,
    "layloToken": null,
    "pollingQuestions": null,
    "fontFamilies": null
  }'

Response

{
  "title": null,
  "description": null,
  "live": false,
  "favIconBlobId": null,
  "favIconBlobReferenceKey": null,
  "shortCutIconBlobId": null,
  "shortCutIconBlobReferenceKey": null,
  "openGraphImageBlobId": null,
  "openGraphImageBlobReferenceKey": null,
  "metaPixelId": null,
  "googleAnalyticsId": null,
  "onSubmitUrl": null,
  "slug": null,
  "externalUrl": null,
  "html": null,
  "style": null,
  "projectData": null,
  "layloEnabled": false,
  "layloToken": null,
  "pollingQuestions": null,
  "fontFamilies": null,
  "qrCodeBlobId": null,
  "lastDesignedAt": null,
  "lastViewedAt": null,
  "lastScannedAt": null,
  "publicId": null,
  "id": 0,
  "viewCount": 0,
  "scanCount": 0,
  "submissions": null,
  "questions": null
}

GET/api/v1/crowdpages

List all crowdpages

Requires authentication

Response· CrowdpageDto

titlestringnullable

optional

descriptionstringnullable

optional

liveboolean

optional

favIconBlobIdinteger (int32)nullable

optional

favIconBlobReferenceKeystringnullable

optional

shortCutIconBlobIdinteger (int32)nullable

optional

shortCutIconBlobReferenceKeystringnullable

optional

openGraphImageBlobIdinteger (int32)nullable

optional

GEThttps://dashboard.crowdpass.co/api/v1/crowdpages

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/crowdpages"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/crowdpages",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/crowdpages \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "title": null,
  "description": null,
  "live": false,
  "favIconBlobId": null,
  "favIconBlobReferenceKey": null,
  "shortCutIconBlobId": null,
  "shortCutIconBlobReferenceKey": null,
  "openGraphImageBlobId": null,
  "openGraphImageBlobReferenceKey": null,
  "metaPixelId": null,
  "googleAnalyticsId": null,
  "onSubmitUrl": null,
  "slug": null,
  "externalUrl": null,
  "html": null,
  "style": null,
  "projectData": null,
  "layloEnabled": false,
  "layloToken": null,
  "pollingQuestions": null,
  "fontFamilies": null,
  "qrCodeBlobId": null,
  "lastDesignedAt": null,
  "lastViewedAt": null,
  "lastScannedAt": null,
  "publicId": null,
  "id": 0,
  "viewCount": 0,
  "scanCount": 0,
  "submissions": null,
  "questions": null
}

PUT/api/v1/crowdpages/{id}

Update crowdpage content

Requires authentication

Parameters

idinteger (int32)

required

Request Body

titlestringnullable

optional

descriptionstringnullable

optional

liveboolean

optional

favIconBlobIdinteger (int32)nullable

optional

favIconBlobReferenceKeystringnullable

optional

shortCutIconBlobIdinteger (int32)nullable

optional

shortCutIconBlobReferenceKeystringnullable

optional

openGraphImageBlobIdinteger (int32)nullable

optional

Response· CrowdpageDto

titlestringnullable

optional

descriptionstringnullable

optional

liveboolean

optional

favIconBlobIdinteger (int32)nullable

optional

favIconBlobReferenceKeystringnullable

optional

shortCutIconBlobIdinteger (int32)nullable

optional

shortCutIconBlobReferenceKeystringnullable

optional

openGraphImageBlobIdinteger (int32)nullable

optional

PUThttps://dashboard.crowdpass.co/api/v1/crowdpages/{id}

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/crowdpages/{id}"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "title": null,
  "description": null,
  "live": false,
  "favIconBlobId": null,
  "favIconBlobReferenceKey": null,
  "shortCutIconBlobId": null,
  "shortCutIconBlobReferenceKey": null,
  "openGraphImageBlobId": null,
  "openGraphImageBlobReferenceKey": null,
  "metaPixelId": null,
  "googleAnalyticsId": null,
  "onSubmitUrl": null,
  "slug": null,
  "externalUrl": null,
  "html": null,
  "style": null,
  "projectData": null,
  "layloEnabled": false,
  "layloToken": null,
  "pollingQuestions": null,
  "fontFamilies": null,
  "id": 0,
  "questions": null
}

response = requests.put(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/crowdpages/{id}",
  {
    method: "PUT",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "title": null,
      "description": null,
      "live": false,
      "favIconBlobId": null,
      "favIconBlobReferenceKey": null,
      "shortCutIconBlobId": null,
      "shortCutIconBlobReferenceKey": null,
      "openGraphImageBlobId": null,
      "openGraphImageBlobReferenceKey": null,
      "metaPixelId": null,
      "googleAnalyticsId": null,
      "onSubmitUrl": null,
      "slug": null,
      "externalUrl": null,
      "html": null,
      "style": null,
      "projectData": null,
      "layloEnabled": false,
      "layloToken": null,
      "pollingQuestions": null,
      "fontFamilies": null,
      "id": 0,
      "questions": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X PUT https://dashboard.crowdpass.co/api/v1/crowdpages/{id} \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "title": null,
    "description": null,
    "live": false,
    "favIconBlobId": null,
    "favIconBlobReferenceKey": null,
    "shortCutIconBlobId": null,
    "shortCutIconBlobReferenceKey": null,
    "openGraphImageBlobId": null,
    "openGraphImageBlobReferenceKey": null,
    "metaPixelId": null,
    "googleAnalyticsId": null,
    "onSubmitUrl": null,
    "slug": null,
    "externalUrl": null,
    "html": null,
    "style": null,
    "projectData": null,
    "layloEnabled": false,
    "layloToken": null,
    "pollingQuestions": null,
    "fontFamilies": null,
    "id": 0,
    "questions": null
  }'

Response

{
  "title": null,
  "description": null,
  "live": false,
  "favIconBlobId": null,
  "favIconBlobReferenceKey": null,
  "shortCutIconBlobId": null,
  "shortCutIconBlobReferenceKey": null,
  "openGraphImageBlobId": null,
  "openGraphImageBlobReferenceKey": null,
  "metaPixelId": null,
  "googleAnalyticsId": null,
  "onSubmitUrl": null,
  "slug": null,
  "externalUrl": null,
  "html": null,
  "style": null,
  "projectData": null,
  "layloEnabled": false,
  "layloToken": null,
  "pollingQuestions": null,
  "fontFamilies": null,
  "qrCodeBlobId": null,
  "lastDesignedAt": null,
  "lastViewedAt": null,
  "lastScannedAt": null,
  "publicId": null,
  "id": 0,
  "viewCount": 0,
  "scanCount": 0,
  "submissions": null,
  "questions": null
}

GET/api/v1/crowdpages/{id}

Get crowdpage details

Requires authentication

Parameters

idinteger (int32)

required

includeSubmissionsboolean

optional

Response· CrowdpageDto

titlestringnullable

optional

descriptionstringnullable

optional

liveboolean

optional

favIconBlobIdinteger (int32)nullable

optional

favIconBlobReferenceKeystringnullable

optional

shortCutIconBlobIdinteger (int32)nullable

optional

shortCutIconBlobReferenceKeystringnullable

optional

openGraphImageBlobIdinteger (int32)nullable

optional

GEThttps://dashboard.crowdpass.co/api/v1/crowdpages/{id}

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/crowdpages/{id}"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/crowdpages/{id}",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/crowdpages/{id} \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "title": null,
  "description": null,
  "live": false,
  "favIconBlobId": null,
  "favIconBlobReferenceKey": null,
  "shortCutIconBlobId": null,
  "shortCutIconBlobReferenceKey": null,
  "openGraphImageBlobId": null,
  "openGraphImageBlobReferenceKey": null,
  "metaPixelId": null,
  "googleAnalyticsId": null,
  "onSubmitUrl": null,
  "slug": null,
  "externalUrl": null,
  "html": null,
  "style": null,
  "projectData": null,
  "layloEnabled": false,
  "layloToken": null,
  "pollingQuestions": null,
  "fontFamilies": null,
  "qrCodeBlobId": null,
  "lastDesignedAt": null,
  "lastViewedAt": null,
  "lastScannedAt": null,
  "publicId": null,
  "id": 0,
  "viewCount": 0,
  "scanCount": 0,
  "submissions": null,
  "questions": null
}

DELETE/api/v1/crowdpages/{id}

Delete a crowdpage

Requires authentication

Parameters

idinteger (int32)

required

Response· CrowdpageDto

titlestringnullable

optional

descriptionstringnullable

optional

liveboolean

optional

favIconBlobIdinteger (int32)nullable

optional

favIconBlobReferenceKeystringnullable

optional

shortCutIconBlobIdinteger (int32)nullable

optional

shortCutIconBlobReferenceKeystringnullable

optional

openGraphImageBlobIdinteger (int32)nullable

optional

DELETEhttps://dashboard.crowdpass.co/api/v1/crowdpages/{id}

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/crowdpages/{id}"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.delete(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/crowdpages/{id}",
  {
    method: "DELETE",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl -X DELETE https://dashboard.crowdpass.co/api/v1/crowdpages/{id} \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "title": null,
  "description": null,
  "live": false,
  "favIconBlobId": null,
  "favIconBlobReferenceKey": null,
  "shortCutIconBlobId": null,
  "shortCutIconBlobReferenceKey": null,
  "openGraphImageBlobId": null,
  "openGraphImageBlobReferenceKey": null,
  "metaPixelId": null,
  "googleAnalyticsId": null,
  "onSubmitUrl": null,
  "slug": null,
  "externalUrl": null,
  "html": null,
  "style": null,
  "projectData": null,
  "layloEnabled": false,
  "layloToken": null,
  "pollingQuestions": null,
  "fontFamilies": null,
  "qrCodeBlobId": null,
  "lastDesignedAt": null,
  "lastViewedAt": null,
  "lastScannedAt": null,
  "publicId": null,
  "id": 0,
  "viewCount": 0,
  "scanCount": 0,
  "submissions": null,
  "questions": null
}

POST/api/v1/crowdpages/checkSlug

Check if crowdpage slug is available

Requires authentication

Request Body

slugstringnullable

optional

POSThttps://dashboard.crowdpass.co/api/v1/crowdpages/checkSlug

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/crowdpages/checkSlug"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "slug": null
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/crowdpages/checkSlug",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "slug": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/crowdpages/checkSlug \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "slug": null
  }'

GET/api/v1/crowdpages/{id}/scans

Get crowdpage scan analytics

Requires authentication

Parameters

idinteger (int32)

required

GEThttps://dashboard.crowdpass.co/api/v1/crowdpages/{id}/scans

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/crowdpages/{id}/scans"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/crowdpages/{id}/scans",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/crowdpages/{id}/scans \
  -H "Authorization: Bearer YOUR_TOKEN"

GET/api/v1/crowdpages/{id}/views

Get crowdpage view analytics

Requires authentication

Parameters

idinteger (int32)

required

GEThttps://dashboard.crowdpass.co/api/v1/crowdpages/{id}/views

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/crowdpages/{id}/views"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/crowdpages/{id}/views",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/crowdpages/{id}/views \
  -H "Authorization: Bearer YOUR_TOKEN"

GET/api/v1/crowdpages/{id}/polling

Get crowdpage polling results

Requires authentication

Parameters

idinteger (int32)

required

GEThttps://dashboard.crowdpass.co/api/v1/crowdpages/{id}/polling

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/crowdpages/{id}/polling"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/crowdpages/{id}/polling",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/crowdpages/{id}/polling \
  -H "Authorization: Bearer YOUR_TOKEN"

Blobs

File upload and binary storage for images, badges, and documents.

9 endpoints

GET/api/public/blobs/{referenceKey}

Get public blob by reference key

Parameters

referenceKeystring

required

GEThttps://dashboard.crowdpass.co/api/public/blobs/{referenceKey}

Request

import requests

url = "https://dashboard.crowdpass.co/api/public/blobs/{referenceKey}"

response = requests.get(url)
print(response.json())

const response = await fetch("https://dashboard.crowdpass.co/api/public/blobs/{referenceKey}");
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/public/blobs/{referenceKey}

POST/api/public/blobs/{eventId}

Upload public blob for event

Parameters

eventIdstring

required

POSThttps://dashboard.crowdpass.co/api/public/blobs/{eventId}

Request

import requests

url = "https://dashboard.crowdpass.co/api/public/blobs/{eventId}"

response = requests.post(url)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/public/blobs/{eventId}",
  {
    method: "POST",
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/public/blobs/{eventId}

GET/api/v1/blobs/{id}

Get file metadata and download URL

Requires authentication

Parameters

idinteger (int32)

required

GEThttps://dashboard.crowdpass.co/api/v1/blobs/{id}

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/blobs/{id}"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/blobs/{id}",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/blobs/{id} \
  -H "Authorization: Bearer YOUR_TOKEN"

GET/api/public/blobs/by-id/{id}

Get public blob by ID

Parameters

idinteger (int32)

required

GEThttps://dashboard.crowdpass.co/api/public/blobs/by-id/{id}

Request

import requests

url = "https://dashboard.crowdpass.co/api/public/blobs/by-id/{id}"

response = requests.get(url)
print(response.json())

const response = await fetch("https://dashboard.crowdpass.co/api/public/blobs/by-id/{id}");
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/public/blobs/by-id/{id}

POST/api/v1/blobs

Upload a file

Requires authentication

Response· BlobDto

idinteger (int32)

optional

referenceKeystringnullable

optional

fileNamestringnullable

optional

contentTypestringnullable

optional

fileSizeinteger (int64)

optional

POSThttps://dashboard.crowdpass.co/api/v1/blobs

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/blobs"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.post(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/blobs",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/blobs \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "id": 0,
  "referenceKey": null,
  "fileName": null,
  "contentType": null,
  "fileSize": 0
}

POST/api/v1/blobs/badges/{eventId}

Upload badge image for event

Requires authentication

Parameters

eventIdinteger (int32)

required

Response· BlobDto

idinteger (int32)

optional

referenceKeystringnullable

optional

fileNamestringnullable

optional

contentTypestringnullable

optional

fileSizeinteger (int64)

optional

POSThttps://dashboard.crowdpass.co/api/v1/blobs/badges/{eventId}

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/blobs/badges/{eventId}"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.post(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/blobs/badges/{eventId}",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/blobs/badges/{eventId} \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "id": 0,
  "referenceKey": null,
  "fileName": null,
  "contentType": null,
  "fileSize": 0
}

GET/api/v1/events/{eventId}/blobs

List blobs for event

Requires authentication

Parameters

eventIdinteger (int32)

required

Returns EventBlobDto[]

GEThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/blobs

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/blobs"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/blobs",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/events/{eventId}/blobs \
  -H "Authorization: Bearer YOUR_TOKEN"

POST/api/v1/events/{eventId}/blobs

Upload blob for event

Requires authentication

Parameters

eventIdinteger (int32)

required

typestring

required

Response· BlobDto

idinteger (int32)

optional

referenceKeystringnullable

optional

fileNamestringnullable

optional

contentTypestringnullable

optional

fileSizeinteger (int64)

optional

POSThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/blobs

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/blobs"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.post(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/blobs",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/events/{eventId}/blobs \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "id": 0,
  "referenceKey": null,
  "fileName": null,
  "contentType": null,
  "fileSize": 0
}

GET/api/v1/events/{eventId}/blobs/{id}

Get event blob details

Requires authentication

Parameters

eventIdinteger (int32)

required

idinteger (int32)

required

GEThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/blobs/{id}

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/blobs/{id}"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/blobs/{id}",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/events/{eventId}/blobs/{id} \
  -H "Authorization: Bearer YOUR_TOKEN"

Photobooth

Event photobooth management, photos, and settings.

5 endpoints

POST/api/v1/events/{eventId}/photobooth

Upload photobooth photo

Requires authentication

Parameters

eventIdinteger (int32)

required

Request Body

eventIdinteger (int32)

optional

photoblobIdinteger (int32)

optional

emailsstring[]nullable

optional

phoneNumbersstring[]nullable

optional

POSThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/photobooth

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/photobooth"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "eventId": 0,
  "photoblobId": 0,
  "emails": null,
  "phoneNumbers": null
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/photobooth",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "eventId": 0,
      "photoblobId": 0,
      "emails": null,
      "phoneNumbers": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/events/{eventId}/photobooth \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "eventId": 0,
    "photoblobId": 0,
    "emails": null,
    "phoneNumbers": null
  }'

GET/api/v1/events/{eventId}/photobooth-photos

List photobooth photos

Requires authentication

Parameters

eventIdinteger (int32)

required

GEThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/photobooth-photos

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/photobooth-photos"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/photobooth-photos",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/events/{eventId}/photobooth-photos \
  -H "Authorization: Bearer YOUR_TOKEN"

POST/api/v1/events/{eventId}/photobooth-settings

Create photobooth settings

Requires authentication

Parameters

eventIdinteger (int32)

required

Request Body

eventIdinteger (int32)

optional

enableNFCboolean

optional

enableBrandingboolean

optional

enableEventLogoboolean

optional

enableDefaultOverlayboolean

optional

enableCustomWelcomeScreenboolean

optional

transparentBackgroundOnLandingboolean

optional

primaryColorstringnullable

optional

POSThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/photobooth-settings

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/photobooth-settings"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "eventId": 0,
  "enableNFC": false,
  "enableBranding": false,
  "enableEventLogo": false,
  "enableDefaultOverlay": false,
  "enableCustomWelcomeScreen": false,
  "transparentBackgroundOnLanding": false,
  "primaryColor": null,
  "secondaryColor": null,
  "tertiaryColor": null,
  "timer": 0,
  "photoboothLogoBlobId": null,
  "customWelcomeScreenBlobId": null,
  "overlayBlobId": null,
  "overlayBlobIds": null,
  "overlayOpacity": 0,
  "securityCode": null
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/photobooth-settings",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "eventId": 0,
      "enableNFC": false,
      "enableBranding": false,
      "enableEventLogo": false,
      "enableDefaultOverlay": false,
      "enableCustomWelcomeScreen": false,
      "transparentBackgroundOnLanding": false,
      "primaryColor": null,
      "secondaryColor": null,
      "tertiaryColor": null,
      "timer": 0,
      "photoboothLogoBlobId": null,
      "customWelcomeScreenBlobId": null,
      "overlayBlobId": null,
      "overlayBlobIds": null,
      "overlayOpacity": 0,
      "securityCode": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/events/{eventId}/photobooth-settings \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "eventId": 0,
    "enableNFC": false,
    "enableBranding": false,
    "enableEventLogo": false,
    "enableDefaultOverlay": false,
    "enableCustomWelcomeScreen": false,
    "transparentBackgroundOnLanding": false,
    "primaryColor": null,
    "secondaryColor": null,
    "tertiaryColor": null,
    "timer": 0,
    "photoboothLogoBlobId": null,
    "customWelcomeScreenBlobId": null,
    "overlayBlobId": null,
    "overlayBlobIds": null,
    "overlayOpacity": 0,
    "securityCode": null
  }'

PUT/api/v1/events/{eventId}/photobooth-settings

Update photobooth settings

Requires authentication

Parameters

eventIdinteger (int32)

required

Request Body

eventIdinteger (int32)

optional

enableNFCboolean

optional

enableBrandingboolean

optional

enableEventLogoboolean

optional

enableDefaultOverlayboolean

optional

enableCustomWelcomeScreenboolean

optional

transparentBackgroundOnLandingboolean

optional

primaryColorstringnullable

optional

PUThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/photobooth-settings

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/photobooth-settings"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "eventId": 0,
  "enableNFC": false,
  "enableBranding": false,
  "enableEventLogo": false,
  "enableDefaultOverlay": false,
  "enableCustomWelcomeScreen": false,
  "transparentBackgroundOnLanding": false,
  "primaryColor": null,
  "secondaryColor": null,
  "tertiaryColor": null,
  "timer": 0,
  "photoboothLogoBlobId": null,
  "customWelcomeScreenBlobId": null,
  "overlayBlobId": null,
  "overlayBlobIds": null,
  "overlayOpacity": 0,
  "securityCode": null,
  "id": 0
}

response = requests.put(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/photobooth-settings",
  {
    method: "PUT",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "eventId": 0,
      "enableNFC": false,
      "enableBranding": false,
      "enableEventLogo": false,
      "enableDefaultOverlay": false,
      "enableCustomWelcomeScreen": false,
      "transparentBackgroundOnLanding": false,
      "primaryColor": null,
      "secondaryColor": null,
      "tertiaryColor": null,
      "timer": 0,
      "photoboothLogoBlobId": null,
      "customWelcomeScreenBlobId": null,
      "overlayBlobId": null,
      "overlayBlobIds": null,
      "overlayOpacity": 0,
      "securityCode": null,
      "id": 0
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X PUT https://dashboard.crowdpass.co/api/v1/events/{eventId}/photobooth-settings \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "eventId": 0,
    "enableNFC": false,
    "enableBranding": false,
    "enableEventLogo": false,
    "enableDefaultOverlay": false,
    "enableCustomWelcomeScreen": false,
    "transparentBackgroundOnLanding": false,
    "primaryColor": null,
    "secondaryColor": null,
    "tertiaryColor": null,
    "timer": 0,
    "photoboothLogoBlobId": null,
    "customWelcomeScreenBlobId": null,
    "overlayBlobId": null,
    "overlayBlobIds": null,
    "overlayOpacity": 0,
    "securityCode": null,
    "id": 0
  }'

GET/api/v1/events/{eventId}/photobooth-settings

Get photobooth settings

Requires authentication

Parameters

eventIdinteger (int32)

required

GEThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/photobooth-settings

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/photobooth-settings"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/photobooth-settings",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/events/{eventId}/photobooth-settings \
  -H "Authorization: Bearer YOUR_TOKEN"

Scheduling

Sessions

Event session scheduling and management.

6 endpoints

POST/api/v1/session

Create a new session

Requires authentication

Request Body

titlestringnullable

optional

displayNamestringnullable

optional

descriptionstringnullable

optional

startDatestring (date-time)

optional

endDatestring (date-time)nullable

optional

durationInMinutesnumber (double)

optional

occuringTypeIdSessionOccuringType

optional

coverImageBlobIdinteger (int32)nullable

optional

Response· Session

idinteger (int32)

optional

isDeletedboolean

optional

deletedAtstring (date-time)nullable

optional

xmininteger (int32)

optional

createdByUserinteger (int32)

optional

createdDatestring (date-time)

optional

lastModifiedByUserinteger (int32)

optional

lastModifiedDatestring (date-time)

optional

POSThttps://dashboard.crowdpass.co/api/v1/session

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/session"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "title": null,
  "displayName": null,
  "description": null,
  "startDate": "2026-01-01T00:00:00Z",
  "endDate": null,
  "durationInMinutes": 0,
  "occuringTypeId": {},
  "coverImageBlobId": null,
  "eventId": 0,
  "sessionHours": null,
  "bookingTypes": null,
  "timezoneOffset": null
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/session",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "title": null,
      "displayName": null,
      "description": null,
      "startDate": "2026-01-01T00:00:00Z",
      "endDate": null,
      "durationInMinutes": 0,
      "occuringTypeId": {},
      "coverImageBlobId": null,
      "eventId": 0,
      "sessionHours": null,
      "bookingTypes": null,
      "timezoneOffset": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/session \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "title": null,
    "displayName": null,
    "description": null,
    "startDate": "2026-01-01T00:00:00Z",
    "endDate": null,
    "durationInMinutes": 0,
    "occuringTypeId": {},
    "coverImageBlobId": null,
    "eventId": 0,
    "sessionHours": null,
    "bookingTypes": null,
    "timezoneOffset": null
  }'

Response

{
  "id": 0,
  "isDeleted": false,
  "deletedAt": null,
  "xmin": 0,
  "createdByUser": 0,
  "createdDate": "2026-01-01T00:00:00Z",
  "lastModifiedByUser": 0,
  "lastModifiedDate": "2026-01-01T00:00:00Z",
  "tenantId": 0,
  "eventId": 0,
  "title": null,
  "displayName": null,
  "description": null,
  "timezoneOffset": 0,
  "startDate": "2026-01-01T00:00:00Z",
  "endDate": null,
  "occuringTypeId": {},
  "durationInMinutes": 0,
  "coverImageId": null,
  "coverImage": {},
  "bookings": null,
  "bookingTypes": null,
  "sessionHours": null
}

GET/api/v1/session/{id}

Get session details

Requires authentication

Parameters

idinteger (int32)

required

Response· SessionDto

titlestringnullable

optional

displayNamestringnullable

optional

descriptionstringnullable

optional

startDatestring (date-time)

optional

endDatestring (date-time)nullable

optional

durationInMinutesnumber (double)

optional

occuringTypeIdSessionOccuringType

optional

coverImageBlobIdinteger (int32)nullable

optional

GEThttps://dashboard.crowdpass.co/api/v1/session/{id}

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/session/{id}"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/session/{id}",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/session/{id} \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "title": null,
  "displayName": null,
  "description": null,
  "startDate": "2026-01-01T00:00:00Z",
  "endDate": null,
  "durationInMinutes": 0,
  "occuringTypeId": {},
  "coverImageBlobId": null,
  "id": 0,
  "timezoneOffset": 0,
  "sessionHours": null,
  "bookingTypes": null
}

DELETE/api/v1/session/{id}

Delete a session

Requires authentication

Parameters

idinteger (int32)

required

DELETEhttps://dashboard.crowdpass.co/api/v1/session/{id}

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/session/{id}"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.delete(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/session/{id}",
  {
    method: "DELETE",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl -X DELETE https://dashboard.crowdpass.co/api/v1/session/{id} \
  -H "Authorization: Bearer YOUR_TOKEN"

GET/api/v1/events/{eventId}/session/getSessionByName

Find session by name

Requires authentication

Parameters

eventIdinteger (int32)

required

namestring

required

Response· SessionDto

titlestringnullable

optional

displayNamestringnullable

optional

descriptionstringnullable

optional

startDatestring (date-time)

optional

endDatestring (date-time)nullable

optional

durationInMinutesnumber (double)

optional

occuringTypeIdSessionOccuringType

optional

coverImageBlobIdinteger (int32)nullable

optional

GEThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/session/getSessionByName

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/session/getSessionByName"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/session/getSessionByName",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/events/{eventId}/session/getSessionByName \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "title": null,
  "displayName": null,
  "description": null,
  "startDate": "2026-01-01T00:00:00Z",
  "endDate": null,
  "durationInMinutes": 0,
  "occuringTypeId": {},
  "coverImageBlobId": null,
  "id": 0,
  "timezoneOffset": 0,
  "sessionHours": null,
  "bookingTypes": null
}

GET/api/v1/events/{eventId}/sessions

List all sessions for an event

Requires authentication

Parameters

eventIdinteger (int32)

required

Returns SessionDto[]

GEThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/sessions

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/sessions"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/sessions",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/events/{eventId}/sessions \
  -H "Authorization: Bearer YOUR_TOKEN"

POST/api/v1/sessionHour

Create session time slot

Requires authentication

Request Body

hourstringnullable

optional

sessionIdinteger (int32)

optional

Response· SessionHourDto

hourstringnullable

optional

idinteger (int32)

optional

POSThttps://dashboard.crowdpass.co/api/v1/sessionHour

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/sessionHour"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "hour": null,
  "sessionId": 0
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/sessionHour",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "hour": null,
      "sessionId": 0
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/sessionHour \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "hour": null,
    "sessionId": 0
  }'

Response

{
  "hour": null,
  "id": 0
}

Bookings

Appointment and meeting booking system with check-in support.

11 endpoints

POST/api/v1/booking

Create a new booking

Requires authentication

Request Body

sessionIdinteger (int32)

optional

attendeeIdinteger (int32)

optional

statusIdBookingStatus

optional

sessionHourIdinteger (int32)

optional

bookingTypeIdinteger (int32)

optional

paymentCompletedboolean

optional

bookingTimestring (date-time)

optional

checkedInboolean

optional

Response· BookingDto

sessionIdinteger (int32)

optional

attendeeIdinteger (int32)

optional

statusIdBookingStatus

optional

sessionHourIdinteger (int32)

optional

bookingTypeIdinteger (int32)

optional

paymentCompletedboolean

optional

bookingTimestring (date-time)

optional

checkedInboolean

optional

POSThttps://dashboard.crowdpass.co/api/v1/booking

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/booking"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "sessionId": 0,
  "attendeeId": 0,
  "statusId": {},
  "sessionHourId": 0,
  "bookingTypeId": 0,
  "paymentCompleted": false,
  "bookingTime": "2026-01-01T00:00:00Z",
  "checkedIn": false,
  "note": null
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/booking",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "sessionId": 0,
      "attendeeId": 0,
      "statusId": {},
      "sessionHourId": 0,
      "bookingTypeId": 0,
      "paymentCompleted": false,
      "bookingTime": "2026-01-01T00:00:00Z",
      "checkedIn": false,
      "note": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/booking \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "sessionId": 0,
    "attendeeId": 0,
    "statusId": {},
    "sessionHourId": 0,
    "bookingTypeId": 0,
    "paymentCompleted": false,
    "bookingTime": "2026-01-01T00:00:00Z",
    "checkedIn": false,
    "note": null
  }'

Response

{
  "sessionId": 0,
  "attendeeId": 0,
  "statusId": {},
  "sessionHourId": 0,
  "bookingTypeId": 0,
  "paymentCompleted": false,
  "bookingTime": "2026-01-01T00:00:00Z",
  "checkedIn": false,
  "note": null,
  "id": 0,
  "bookingType": {}
}

POST/api/v1/booking/request

Submit a booking request

Requires authentication

Request Body

datastringnullable

optional

Response· BookingDto

sessionIdinteger (int32)

optional

attendeeIdinteger (int32)

optional

statusIdBookingStatus

optional

sessionHourIdinteger (int32)

optional

bookingTypeIdinteger (int32)

optional

paymentCompletedboolean

optional

bookingTimestring (date-time)

optional

checkedInboolean

optional

POSThttps://dashboard.crowdpass.co/api/v1/booking/request

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/booking/request"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "data": null
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/booking/request",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "data": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/booking/request \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "data": null
  }'

Response

{
  "sessionId": 0,
  "attendeeId": 0,
  "statusId": {},
  "sessionHourId": 0,
  "bookingTypeId": 0,
  "paymentCompleted": false,
  "bookingTime": "2026-01-01T00:00:00Z",
  "checkedIn": false,
  "note": null,
  "id": 0,
  "bookingType": {}
}

GET/api/v1/booking/{id}

Get booking details

Requires authentication

Parameters

idinteger (int32)

required

Response· BookingDto

sessionIdinteger (int32)

optional

attendeeIdinteger (int32)

optional

statusIdBookingStatus

optional

sessionHourIdinteger (int32)

optional

bookingTypeIdinteger (int32)

optional

paymentCompletedboolean

optional

bookingTimestring (date-time)

optional

checkedInboolean

optional

GEThttps://dashboard.crowdpass.co/api/v1/booking/{id}

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/booking/{id}"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/booking/{id}",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/booking/{id} \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "sessionId": 0,
  "attendeeId": 0,
  "statusId": {},
  "sessionHourId": 0,
  "bookingTypeId": 0,
  "paymentCompleted": false,
  "bookingTime": "2026-01-01T00:00:00Z",
  "checkedIn": false,
  "note": null,
  "id": 0,
  "bookingType": {}
}

PUT/api/v1/booking/{id}

Update a booking

Requires authentication

Parameters

idinteger (int32)

required

Request Body

sessionIdinteger (int32)

optional

attendeeIdinteger (int32)

optional

statusIdBookingStatus

optional

sessionHourIdinteger (int32)

optional

bookingTypeIdinteger (int32)

optional

paymentCompletedboolean

optional

bookingTimestring (date-time)

optional

checkedInboolean

optional

PUThttps://dashboard.crowdpass.co/api/v1/booking/{id}

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/booking/{id}"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "sessionId": 0,
  "attendeeId": 0,
  "statusId": {},
  "sessionHourId": 0,
  "bookingTypeId": 0,
  "paymentCompleted": false,
  "bookingTime": "2026-01-01T00:00:00Z",
  "checkedIn": false,
  "note": null,
  "id": 0,
  "bookingType": {}
}

response = requests.put(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/booking/{id}",
  {
    method: "PUT",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "sessionId": 0,
      "attendeeId": 0,
      "statusId": {},
      "sessionHourId": 0,
      "bookingTypeId": 0,
      "paymentCompleted": false,
      "bookingTime": "2026-01-01T00:00:00Z",
      "checkedIn": false,
      "note": null,
      "id": 0,
      "bookingType": {}
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X PUT https://dashboard.crowdpass.co/api/v1/booking/{id} \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "sessionId": 0,
    "attendeeId": 0,
    "statusId": {},
    "sessionHourId": 0,
    "bookingTypeId": 0,
    "paymentCompleted": false,
    "bookingTime": "2026-01-01T00:00:00Z",
    "checkedIn": false,
    "note": null,
    "id": 0,
    "bookingType": {}
  }'

DELETE/api/v1/booking/{id}

Cancel a booking

Requires authentication

Parameters

idinteger (int32)

required

DELETEhttps://dashboard.crowdpass.co/api/v1/booking/{id}

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/booking/{id}"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.delete(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/booking/{id}",
  {
    method: "DELETE",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl -X DELETE https://dashboard.crowdpass.co/api/v1/booking/{id} \
  -H "Authorization: Bearer YOUR_TOKEN"

GET/api/v1/attendees/{attendeeId}/bookings

List bookings for an attendee

Requires authentication

Parameters

attendeeIdinteger (int32)

required

Returns BookingDto[]

GEThttps://dashboard.crowdpass.co/api/v1/attendees/{attendeeId}/bookings

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/attendees/{attendeeId}/bookings"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/attendees/{attendeeId}/bookings",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/attendees/{attendeeId}/bookings \
  -H "Authorization: Bearer YOUR_TOKEN"

GET/api/v1/session/{sessionId}/bookings

List bookings for a session

Requires authentication

Parameters

sessionIdinteger (int32)

required

datestring

optional

sessionHourIdinteger (int32)

optional

Returns BookingDto[]

GEThttps://dashboard.crowdpass.co/api/v1/session/{sessionId}/bookings

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/session/{sessionId}/bookings"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/session/{sessionId}/bookings",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/session/{sessionId}/bookings \
  -H "Authorization: Bearer YOUR_TOKEN"

GET/api/v1/session/{sessionId}/attendees

List attendees for a session

Requires authentication

Parameters

sessionIdinteger (int32)

required

datestring

optional

sessionHourIdinteger (int32)

optional

Returns AttendeeWithBookingDto[]

GEThttps://dashboard.crowdpass.co/api/v1/session/{sessionId}/attendees

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/session/{sessionId}/attendees"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/session/{sessionId}/attendees",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/session/{sessionId}/attendees \
  -H "Authorization: Bearer YOUR_TOKEN"

GET/api/v1/events/{eventId}/bookings

List all bookings for an event

Requires authentication

Parameters

eventIdinteger (int32)

required

datestring

optional

Returns BookingDto[]

GEThttps://dashboard.crowdpass.co/api/v1/events/{eventId}/bookings

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/events/{eventId}/bookings"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/events/{eventId}/bookings",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/events/{eventId}/bookings \
  -H "Authorization: Bearer YOUR_TOKEN"

POST/api/v1/bookingType

Create a booking type

Requires authentication

Request Body

sessionIdinteger (int32)

optional

titlestringnullable

optional

descriptionstringnullable

optional

pricenumber (double)

optional

limitinteger (int32)

optional

Response· BookingType

idinteger (int32)

optional

isDeletedboolean

optional

deletedAtstring (date-time)nullable

optional

xmininteger (int32)

optional

createdByUserinteger (int32)

optional

createdDatestring (date-time)

optional

lastModifiedByUserinteger (int32)

optional

lastModifiedDatestring (date-time)

optional

POSThttps://dashboard.crowdpass.co/api/v1/bookingType

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/bookingType"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "sessionId": 0,
  "title": null,
  "description": null,
  "price": 0,
  "limit": 0
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/bookingType",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "sessionId": 0,
      "title": null,
      "description": null,
      "price": 0,
      "limit": 0
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/bookingType \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "sessionId": 0,
    "title": null,
    "description": null,
    "price": 0,
    "limit": 0
  }'

Response

{
  "id": 0,
  "isDeleted": false,
  "deletedAt": null,
  "xmin": 0,
  "createdByUser": 0,
  "createdDate": "2026-01-01T00:00:00Z",
  "lastModifiedByUser": 0,
  "lastModifiedDate": "2026-01-01T00:00:00Z",
  "sessionId": 0,
  "title": null,
  "description": null,
  "price": 0,
  "limit": 0
}

POST/api/v1/booking/{id}/checkIn

Check in for a booking

Requires authentication

Parameters

idinteger (int32)

required

Response· BookingType

idinteger (int32)

optional

isDeletedboolean

optional

deletedAtstring (date-time)nullable

optional

xmininteger (int32)

optional

createdByUserinteger (int32)

optional

createdDatestring (date-time)

optional

lastModifiedByUserinteger (int32)

optional

lastModifiedDatestring (date-time)

optional

POSThttps://dashboard.crowdpass.co/api/v1/booking/{id}/checkIn

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/booking/{id}/checkIn"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.post(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/booking/{id}/checkIn",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/booking/{id}/checkIn \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "id": 0,
  "isDeleted": false,
  "deletedAt": null,
  "xmin": 0,
  "createdByUser": 0,
  "createdDate": "2026-01-01T00:00:00Z",
  "lastModifiedByUser": 0,
  "lastModifiedDate": "2026-01-01T00:00:00Z",
  "sessionId": 0,
  "title": null,
  "description": null,
  "price": 0,
  "limit": 0
}

Infrastructure

Devices

Check-in device registration, status management, and access control.

5 endpoints

POST/api/v1/devices

Requires authentication

Request Body

identifierstringnullable

optional

displayNamestringnullable

optional

deviceTypeDeviceType

optional

notestringnullable

optional

gateIdinteger (int32)nullable

optional

companyIdinteger (int32)nullable

optional

lastDataReceivedstring (date-time)nullable

optional

batteryLevelinteger (int32)nullable

optional

POSThttps://dashboard.crowdpass.co/api/v1/devices

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/devices"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "identifier": null,
  "displayName": null,
  "deviceType": {},
  "note": null,
  "gateId": null,
  "companyId": null,
  "lastDataReceived": null,
  "batteryLevel": null,
  "isOnline": false,
  "purpose": {}
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/devices",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "identifier": null,
      "displayName": null,
      "deviceType": {},
      "note": null,
      "gateId": null,
      "companyId": null,
      "lastDataReceived": null,
      "batteryLevel": null,
      "isOnline": false,
      "purpose": {}
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/devices \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "identifier": null,
    "displayName": null,
    "deviceType": {},
    "note": null,
    "gateId": null,
    "companyId": null,
    "lastDataReceived": null,
    "batteryLevel": null,
    "isOnline": false,
    "purpose": {}
  }'

PUT/api/v1/devices

Update device configuration

Requires authentication

Request Body

identifierstringnullable

optional

displayNamestringnullable

optional

deviceTypeDeviceType

optional

notestringnullable

optional

gateIdinteger (int32)nullable

optional

companyIdinteger (int32)nullable

optional

lastDataReceivedstring (date-time)nullable

optional

batteryLevelinteger (int32)nullable

optional

PUThttps://dashboard.crowdpass.co/api/v1/devices

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/devices"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "identifier": null,
  "displayName": null,
  "deviceType": {},
  "note": null,
  "gateId": null,
  "companyId": null,
  "lastDataReceived": null,
  "batteryLevel": null,
  "isOnline": false,
  "purpose": {},
  "id": 0
}

response = requests.put(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/devices",
  {
    method: "PUT",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "identifier": null,
      "displayName": null,
      "deviceType": {},
      "note": null,
      "gateId": null,
      "companyId": null,
      "lastDataReceived": null,
      "batteryLevel": null,
      "isOnline": false,
      "purpose": {},
      "id": 0
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X PUT https://dashboard.crowdpass.co/api/v1/devices \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "identifier": null,
    "displayName": null,
    "deviceType": {},
    "note": null,
    "gateId": null,
    "companyId": null,
    "lastDataReceived": null,
    "batteryLevel": null,
    "isOnline": false,
    "purpose": {},
    "id": 0
  }'

GET/api/v1/devices

List all registered devices

Requires authentication

Returns DeviceDto[]

GEThttps://dashboard.crowdpass.co/api/v1/devices

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/devices"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/devices",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/devices \
  -H "Authorization: Bearer YOUR_TOKEN"

GET/api/v1/devices/access

Get device access permissions

Requires authentication

Parameters

identifierstring

required

wristbandUuidstring

required

GEThttps://dashboard.crowdpass.co/api/v1/devices/access

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/devices/access"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/devices/access",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/devices/access \
  -H "Authorization: Bearer YOUR_TOKEN"

POST/api/v1/devices/change-status

Change device status

Requires authentication

Request Body

isOnlineboolean

optional

identifierstringnullable

optional

POSThttps://dashboard.crowdpass.co/api/v1/devices/change-status

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/devices/change-status"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "isOnline": false,
  "identifier": null
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/devices/change-status",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "isOnline": false,
      "identifier": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/devices/change-status \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "isOnline": false,
    "identifier": null
  }'

Integrations

Third-party service connections, trackable links, and event integrations.

6 endpoints

POST/api/public/integration/posh

Receive Posh integration webhook

Parameters

keystring

required

Posh-Secretstring

optional

Request Body

typestringnullable

optional

account_first_namestringnullable

optional

account_last_namestringnullable

optional

account_emailstringnullable

optional

account_phonestringnullable

optional

itemsPoshItemDto[]nullable

optional

date_purchasedstring (date-time)

optional

order_numberinteger (int32)

optional

Response· IntegrationDto

eventIdinteger (int32)

optional

apiKeystringnullable

optional

integrationEventIdstringnullable

optional

integrationTypestringnullable

optional

clientIdstringnullable

optional

clientSecretstringnullable

optional

usernamestringnullable

optional

passwordstringnullable

optional

POSThttps://dashboard.crowdpass.co/api/public/integration/posh

Request

import requests

url = "https://dashboard.crowdpass.co/api/public/integration/posh"
payload = {
  "type": null,
  "account_first_name": null,
  "account_last_name": null,
  "account_email": null,
  "account_phone": null,
  "items": null,
  "date_purchased": "2026-01-01T00:00:00Z",
  "order_number": 0,
  "promo_code": null,
  "subtotal": 0,
  "total": 0,
  "event_name": null,
  "event_start": "2026-01-01T00:00:00Z",
  "event_end": "2026-01-01T00:00:00Z",
  "event_id": null,
  "tracking_link": null
}

response = requests.post(url, json=payload)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/public/integration/posh",
  {
    method: "POST",
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "type": null,
      "account_first_name": null,
      "account_last_name": null,
      "account_email": null,
      "account_phone": null,
      "items": null,
      "date_purchased": "2026-01-01T00:00:00Z",
      "order_number": 0,
      "promo_code": null,
      "subtotal": 0,
      "total": 0,
      "event_name": null,
      "event_start": "2026-01-01T00:00:00Z",
      "event_end": "2026-01-01T00:00:00Z",
      "event_id": null,
      "tracking_link": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/public/integration/posh \
  -H "Content-Type: application/json" \
  -d '{
    "type": null,
    "account_first_name": null,
    "account_last_name": null,
    "account_email": null,
    "account_phone": null,
    "items": null,
    "date_purchased": "2026-01-01T00:00:00Z",
    "order_number": 0,
    "promo_code": null,
    "subtotal": 0,
    "total": 0,
    "event_name": null,
    "event_start": "2026-01-01T00:00:00Z",
    "event_end": "2026-01-01T00:00:00Z",
    "event_id": null,
    "tracking_link": null
  }'

Response

{
  "eventId": 0,
  "apiKey": null,
  "integrationEventId": null,
  "integrationType": null,
  "clientId": null,
  "clientSecret": null,
  "username": null,
  "password": null,
  "id": 0
}

POST/api/v1/integration

Create a new integration

Requires authentication

Request Body

eventIdinteger (int32)

optional

apiKeystringnullable

optional

integrationEventIdstringnullable

optional

integrationTypestringnullable

optional

clientIdstringnullable

optional

clientSecretstringnullable

optional

usernamestringnullable

optional

passwordstringnullable

optional

Response· IntegrationDto

eventIdinteger (int32)

optional

apiKeystringnullable

optional

integrationEventIdstringnullable

optional

integrationTypestringnullable

optional

clientIdstringnullable

optional

clientSecretstringnullable

optional

usernamestringnullable

optional

passwordstringnullable

optional

POSThttps://dashboard.crowdpass.co/api/v1/integration

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/integration"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "eventId": 0,
  "apiKey": null,
  "integrationEventId": null,
  "integrationType": null,
  "clientId": null,
  "clientSecret": null,
  "username": null,
  "password": null
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/integration",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "eventId": 0,
      "apiKey": null,
      "integrationEventId": null,
      "integrationType": null,
      "clientId": null,
      "clientSecret": null,
      "username": null,
      "password": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/integration \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "eventId": 0,
    "apiKey": null,
    "integrationEventId": null,
    "integrationType": null,
    "clientId": null,
    "clientSecret": null,
    "username": null,
    "password": null
  }'

Response

{
  "eventId": 0,
  "apiKey": null,
  "integrationEventId": null,
  "integrationType": null,
  "clientId": null,
  "clientSecret": null,
  "username": null,
  "password": null,
  "id": 0
}

GET/api/v1/{eventId}/integration

List integrations for event

Requires authentication

Parameters

eventIdinteger (int32)

required

Response· IntegrationDto

eventIdinteger (int32)

optional

apiKeystringnullable

optional

integrationEventIdstringnullable

optional

integrationTypestringnullable

optional

clientIdstringnullable

optional

clientSecretstringnullable

optional

usernamestringnullable

optional

passwordstringnullable

optional

GEThttps://dashboard.crowdpass.co/api/v1/{eventId}/integration

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/{eventId}/integration"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/{eventId}/integration",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/{eventId}/integration \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "eventId": 0,
  "apiKey": null,
  "integrationEventId": null,
  "integrationType": null,
  "clientId": null,
  "clientSecret": null,
  "username": null,
  "password": null,
  "id": 0
}

PUT/api/v1/integration/{id}

Update integration configuration

Requires authentication

Parameters

idinteger (int32)

required

Request Body

eventIdinteger (int32)

optional

apiKeystringnullable

optional

integrationEventIdstringnullable

optional

integrationTypestringnullable

optional

clientIdstringnullable

optional

clientSecretstringnullable

optional

usernamestringnullable

optional

passwordstringnullable

optional

PUThttps://dashboard.crowdpass.co/api/v1/integration/{id}

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/integration/{id}"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "eventId": 0,
  "apiKey": null,
  "integrationEventId": null,
  "integrationType": null,
  "clientId": null,
  "clientSecret": null,
  "username": null,
  "password": null
}

response = requests.put(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/integration/{id}",
  {
    method: "PUT",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "eventId": 0,
      "apiKey": null,
      "integrationEventId": null,
      "integrationType": null,
      "clientId": null,
      "clientSecret": null,
      "username": null,
      "password": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X PUT https://dashboard.crowdpass.co/api/v1/integration/{id} \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "eventId": 0,
    "apiKey": null,
    "integrationEventId": null,
    "integrationType": null,
    "clientId": null,
    "clientSecret": null,
    "username": null,
    "password": null
  }'

GET/api/public/link/{slug}

Resolve trackable link by slug

Parameters

slugstring

required

Response· CrowdpageDto

titlestringnullable

optional

descriptionstringnullable

optional

liveboolean

optional

favIconBlobIdinteger (int32)nullable

optional

favIconBlobReferenceKeystringnullable

optional

shortCutIconBlobIdinteger (int32)nullable

optional

shortCutIconBlobReferenceKeystringnullable

optional

openGraphImageBlobIdinteger (int32)nullable

optional

GEThttps://dashboard.crowdpass.co/api/public/link/{slug}

Request

import requests

url = "https://dashboard.crowdpass.co/api/public/link/{slug}"

response = requests.get(url)
print(response.json())

const response = await fetch("https://dashboard.crowdpass.co/api/public/link/{slug}");
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/public/link/{slug}

Response

{
  "title": null,
  "description": null,
  "live": false,
  "favIconBlobId": null,
  "favIconBlobReferenceKey": null,
  "shortCutIconBlobId": null,
  "shortCutIconBlobReferenceKey": null,
  "openGraphImageBlobId": null,
  "openGraphImageBlobReferenceKey": null,
  "metaPixelId": null,
  "googleAnalyticsId": null,
  "onSubmitUrl": null,
  "slug": null,
  "externalUrl": null,
  "html": null,
  "style": null,
  "projectData": null,
  "layloEnabled": false,
  "layloToken": null,
  "pollingQuestions": null,
  "fontFamilies": null,
  "qrCodeBlobId": null,
  "lastDesignedAt": null,
  "lastViewedAt": null,
  "lastScannedAt": null,
  "publicId": null,
  "id": 0,
  "viewCount": 0,
  "scanCount": 0,
  "submissions": null,
  "questions": null
}

POST/api/public/link/{slug}/view

Record trackable link click

Parameters

slugstring

required

POSThttps://dashboard.crowdpass.co/api/public/link/{slug}/view

Request

import requests

url = "https://dashboard.crowdpass.co/api/public/link/{slug}/view"

response = requests.post(url)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/public/link/{slug}/view",
  {
    method: "POST",
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/public/link/{slug}/view

Subscriptions

Plan management, Stripe checkout, usage tracking, and billing.

17 endpoints

POST/api/public/stripe/webhook

Receive Stripe webhook events

POSThttps://dashboard.crowdpass.co/api/public/stripe/webhook

Request

import requests

url = "https://dashboard.crowdpass.co/api/public/stripe/webhook"

response = requests.post(url)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/public/stripe/webhook",
  {
    method: "POST",
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/public/stripe/webhook

GET/api/v1/subscriptions/plans

List available subscription plans

Requires authentication

Returns SubscriptionPlanModel[]

GEThttps://dashboard.crowdpass.co/api/v1/subscriptions/plans

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/subscriptions/plans"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/subscriptions/plans",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/subscriptions/plans \
  -H "Authorization: Bearer YOUR_TOKEN"

GET/api/v1/subscription

Get current subscription

Requires authentication

Returns CompanySubscriptionPlan[]

GEThttps://dashboard.crowdpass.co/api/v1/subscription

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/subscription"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/subscription",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/subscription \
  -H "Authorization: Bearer YOUR_TOKEN"

POST/api/v1/subscription

Create a subscription

Requires authentication

Request Body

companyIdinteger (int32)nullable

optional

expireDatestring (date-time)

optional

stripeProductIdstringnullable

optional

adminSeatsinteger (int32)

optional

Response· CompanySubscriptionPlan

idinteger (int32)

optional

isDeletedboolean

optional

deletedAtstring (date-time)nullable

optional

xmininteger (int32)

optional

createdByUserinteger (int32)

optional

createdDatestring (date-time)

optional

lastModifiedByUserinteger (int32)

optional

lastModifiedDatestring (date-time)

optional

POSThttps://dashboard.crowdpass.co/api/v1/subscription

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/subscription"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "companyId": null,
  "expireDate": "2026-01-01T00:00:00Z",
  "stripeProductId": null,
  "adminSeats": 0
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/subscription",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "companyId": null,
      "expireDate": "2026-01-01T00:00:00Z",
      "stripeProductId": null,
      "adminSeats": 0
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/subscription \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "companyId": null,
    "expireDate": "2026-01-01T00:00:00Z",
    "stripeProductId": null,
    "adminSeats": 0
  }'

Response

{
  "id": 0,
  "isDeleted": false,
  "deletedAt": null,
  "xmin": 0,
  "createdByUser": 0,
  "createdDate": "2026-01-01T00:00:00Z",
  "lastModifiedByUser": 0,
  "lastModifiedDate": "2026-01-01T00:00:00Z",
  "tenantId": 0,
  "companyId": 0,
  "company": {},
  "subscriptionProductId": 0,
  "subscriptionProduct": {},
  "stripeSubscriptionId": null,
  "stripeUsageSubscriptionId": null,
  "isAnnualPlan": false,
  "registrationsPerMonth": 0,
  "planPrice": 0,
  "planName": null,
  "stripeProductId": null,
  "costPerExtraRegistration": 0,
  "numberOfAdminUsers": 0,
  "numberOfRegistrationsThisMonth": 0,
  "totalNumberOfRegistrations": 0,
  "totalNumberOfExtraRegistrations": 0,
  "subscriptionDayInMonth": 0,
  "subscriptionDate": "2026-01-01T00:00:00Z",
  "expiresAt": "2026-01-01T00:00:00Z",
  "nextUsageDate": "2026-01-01T00:00:00Z",
  "cancelledDate": null,
  "discountPercentageOnTicketFees": 0,
  "numberOfUsedAdminSeats": null
}

GET/api/v1/subscriptions/company/{companyId}

Get subscription for company

Requires authentication

Parameters

companyIdinteger (int32)

required

Response· SubscriptionDetailsDto

companyIdinteger (int32)

optional

companyNamestringnullable

optional

companyEmailstringnullable

optional

planNamestringnullable

optional

stripeProductIdstringnullable

optional

stripeSubscriptionIdstringnullable

optional

isAnnualPlanboolean

optional

registrationsPerMonthinteger (int32)

optional

GEThttps://dashboard.crowdpass.co/api/v1/subscriptions/company/{companyId}

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/subscriptions/company/{companyId}"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/subscriptions/company/{companyId}",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/subscriptions/company/{companyId} \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "companyId": 0,
  "companyName": null,
  "companyEmail": null,
  "planName": null,
  "stripeProductId": null,
  "stripeSubscriptionId": null,
  "isAnnualPlan": false,
  "registrationsPerMonth": 0,
  "costPerExtraRegistration": 0,
  "numberOfAdminUsers": 0,
  "numberOfUsedAdminSeats": 0,
  "numberOfRegistrationsThisMonth": 0,
  "totalNumberOfRegistrations": 0,
  "subscriptionDate": "2026-01-01T00:00:00Z",
  "expiresAt": "2026-01-01T00:00:00Z",
  "cancelledDate": null,
  "discountPercentageOnTicketFees": 0
}

GET/api/v1/subscriptions

List all subscriptions

Requires authentication

Returns Company[]

GEThttps://dashboard.crowdpass.co/api/v1/subscriptions

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/subscriptions"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/subscriptions",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/subscriptions \
  -H "Authorization: Bearer YOUR_TOKEN"

GET/api/v1/payment/pricing

Get pricing plans

Requires authentication

Response· PaymentPricingModel

productsPaymentPricingProductModel[]nullable

optional

GEThttps://dashboard.crowdpass.co/api/v1/payment/pricing

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/payment/pricing"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/payment/pricing",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/payment/pricing \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "products": null
}

POST/api/v1/subscriptions/checkout

Start subscription checkout

Requires authentication

Parameters

stripePlanPriceIdstring

required

stripeUsagePriceIdstring

required

isAnnualPlanboolean

required

eventIdinteger (int32)

optional

Response· CreateCheckoutSessionResult

redirectUrlstringnullable

optional

POSThttps://dashboard.crowdpass.co/api/v1/subscriptions/checkout

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/subscriptions/checkout"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.post(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/subscriptions/checkout",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/subscriptions/checkout \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "redirectUrl": null
}

POST/api/v1/subscriptions/checkout/complete

Complete subscription checkout

Requires authentication

Parameters

checkoutSessionIdstring

required

usagePriceIdstring

optional

eventIdinteger (int32)

optional

POSThttps://dashboard.crowdpass.co/api/v1/subscriptions/checkout/complete

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/subscriptions/checkout/complete"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.post(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/subscriptions/checkout/complete",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/subscriptions/checkout/complete \
  -H "Authorization: Bearer YOUR_TOKEN"

POST/api/v1/subscriptions/cancel

Cancel a subscription

Requires authentication

Parameters

companyIdinteger (int32)

optional

POSThttps://dashboard.crowdpass.co/api/v1/subscriptions/cancel

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/subscriptions/cancel"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.post(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/subscriptions/cancel",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/subscriptions/cancel \
  -H "Authorization: Bearer YOUR_TOKEN"

PUT/api/v1/subscriptions/upgrade

Upgrade subscription plan

Requires authentication

Request Body

stripeProductIdstringnullable

optional

PUThttps://dashboard.crowdpass.co/api/v1/subscriptions/upgrade

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/subscriptions/upgrade"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "stripeProductId": null
}

response = requests.put(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/subscriptions/upgrade",
  {
    method: "PUT",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "stripeProductId": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X PUT https://dashboard.crowdpass.co/api/v1/subscriptions/upgrade \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "stripeProductId": null
  }'

PUT/api/v1/subscriptions/{companyId}/details

Update subscription details

Requires authentication

Parameters

companyIdinteger (int32)

required

Request Body

numberOfAdminUsersinteger (int32)

optional

costPerExtraRegistrationnumber (double)

optional

maxRegistrationsinteger (int32)

optional

expiresAtstring (date-time)nullable

optional

PUThttps://dashboard.crowdpass.co/api/v1/subscriptions/{companyId}/details

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/subscriptions/{companyId}/details"
headers = {"Authorization": "Bearer YOUR_TOKEN"}
payload = {
  "numberOfAdminUsers": 0,
  "costPerExtraRegistration": 0,
  "maxRegistrations": 0,
  "expiresAt": null
}

response = requests.put(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/subscriptions/{companyId}/details",
  {
    method: "PUT",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "numberOfAdminUsers": 0,
      "costPerExtraRegistration": 0,
      "maxRegistrations": 0,
      "expiresAt": null
    }),
  }
);
const data = await response.json();
console.log(data);

curl -X PUT https://dashboard.crowdpass.co/api/v1/subscriptions/{companyId}/details \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "numberOfAdminUsers": 0,
    "costPerExtraRegistration": 0,
    "maxRegistrations": 0,
    "expiresAt": null
  }'

POST/api/v1/coupons

Create a coupon code

Requires authentication

Parameters

codestring

required

POSThttps://dashboard.crowdpass.co/api/v1/coupons

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/coupons"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.post(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/coupons",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/coupons \
  -H "Authorization: Bearer YOUR_TOKEN"

GET/api/v1/coupons

List all coupon codes

Requires authentication

GEThttps://dashboard.crowdpass.co/api/v1/coupons

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/coupons"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/coupons",
  {
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl https://dashboard.crowdpass.co/api/v1/coupons \
  -H "Authorization: Bearer YOUR_TOKEN"

POST/api/v1/payment/checkout

Start payment checkout session

Requires authentication

Parameters

typestring

required

quantityinteger (int32)

required

includeAccessoryboolean

optional

sourcestring

optional

eventIdinteger (int32)

optional

Response· CreateCheckoutSessionResult

redirectUrlstringnullable

optional

POSThttps://dashboard.crowdpass.co/api/v1/payment/checkout

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/payment/checkout"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.post(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/payment/checkout",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/payment/checkout \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "redirectUrl": null
}

POST/api/v1/payment/checkout/complete

Complete payment checkout

Requires authentication

Parameters

checkoutSessionIdstring

required

typestring

required

eventIdinteger (int32)

optional

POSThttps://dashboard.crowdpass.co/api/v1/payment/checkout/complete

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/payment/checkout/complete"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.post(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/payment/checkout/complete",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/payment/checkout/complete \
  -H "Authorization: Bearer YOUR_TOKEN"

POST/api/v1/billing/portal

Open Stripe billing portal

Requires authentication

Parameters

returnUrlstring

optional

Response· CreatePortalSessionResult

portalUrlstringnullable

optional

POSThttps://dashboard.crowdpass.co/api/v1/billing/portal

Request

import requests

url = "https://dashboard.crowdpass.co/api/v1/billing/portal"
headers = {"Authorization": "Bearer YOUR_TOKEN"}

response = requests.post(url, headers=headers)
print(response.json())

const response = await fetch(
  "https://dashboard.crowdpass.co/api/v1/billing/portal",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN"
    },
  }
);
const data = await response.json();
console.log(data);

curl -X POST https://dashboard.crowdpass.co/api/v1/billing/portal \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "portalUrl": null
}