1. Overview

Version: 1.59.3

1.1. Seatmap.pro Management API v2

Enterprise administration API for managing organizational structure, user access, and tenant configurations. Restricted to super admin users with elevated privileges.

1.1.1. Core Capabilities

Organization Management

  • Create organizations - Establish new organizational entities with user credentials

  • Update organizations - Modify organizational details and settings

  • List organizations - Retrieve all organizations with pagination support

  • Delete organizations - Remove organizational entities and associated data

  • Access control - Manage API keys and authentication tokens

Administrative Features

  • User provisioning - Create initial admin users with organization setup

  • Token management - Generate and revoke organization-level API tokens

  • Multi-tenancy - Manage multiple organizations within tenant boundaries

  • Audit capabilities - Track organizational changes and access patterns

1.1.2. API Design

Response Formats

  • Success responses - JSON with organizational data and HTTP status codes

  • Error responses - RFC 7807 Problem Details with enhanced metadata (see Error Response Format section below)

  • Pagination - Standard page/size parameters for organization listings

Authentication

All endpoints require tenant-level authentication: [source]

X-API-Key: TEN:{maskedTenantId}:{tenantToken}

Tenant tokens are obtained from the Editor application login response and provide elevated super admin access. For detailed access management, see Managing Access.

1.1.3. Implementation Guidelines

Security Requirements

  • Restricted access - Only super admin users should access these endpoints

  • Token security - Store tenant tokens securely (encrypted at rest)

  • Audit logging - Log all management operations for compliance

  • Rate limiting - Implement exponential backoff for 429 responses

Best Practices

  • Error handling - Parse RFC 7807 error responses with field-level details

  • Validation - Pre-validate organization data before submission

  • Idempotency - Handle duplicate organization creation gracefully

  • Connection pooling - Reuse HTTP connections for multiple requests

Enhanced Error Response Format: All error responses follow RFC 7807 Problem Details format with additional metadata:

  • type - URI reference identifying the problem type (default: about:blank)

  • title - Human-readable summary of the error category

  • status - HTTP status code

  • detail - Human-readable explanation of the specific error

  • instance - URI reference of the specific occurrence

  • timestamp - ISO-8601 timestamp when the error occurred

  • path - Request path that triggered the error

  • errorCode - Machine-readable error category code

  • errors - Array of detailed field-level errors (for validation failures) Each error in the errors array contains:

  • field - Name of the field that failed validation

  • message - Human-readable error message

  • rejectedValue - The invalid value that was submitted (may be null)

  • code - Validation constraint code (e.g., NOT_NULL, SIZE)

2. Quick Start

Unresolved directive in <stdin> - include::../../examples/authentication.adoc[]

Unresolved directive in <stdin> - include::../../examples/error-handling.adoc[]

Unresolved directive in <stdin> - include::../../examples/pagination.adoc[]

3. API Endpoints

Endpoints are organized by functional area. Each section includes detailed information about available operations.

3.1. Organizations

Organization administration endpoints restricted to super admin users. Manages organizational structure, authentication keys, and domain configurations. Requires elevated access privileges.

3.1.1. POST /api/private/management/v2.0/organizations/

Operation: addOrganization

Create a organization

Create a organization
Parameters
Body Parameter

Name

Description

Required

Default

OrganizationWithUser

OrganizationWithUser

X
Return Type

Organization

Content Type

  • /

  • application/problem+json

  • application/json

Responses
Table 1. HTTP Response Codes

Code

Message

Datatype

201

Organization created successfully

Organization

400

ProblemDetail

403

ProblemDetail

500

ProblemDetail
Request Content Type

  • application/json

Examples
HTTP Request
cURL Request
HTTP Response

3.1.2. DELETE /api/private/management/v2.0/organizations/{id}

Operation: deleteOrganizationById

Delete a organization

Delete a organization
Parameters
Body Parameter

Name

Description

Required

Default
Path Parameters

Name

Description

Required

Default

id

X

null
Return Type

-

Content Type

  • application/problem+json

  • application/json

Responses
Table 2. HTTP Response Codes

Code

Message

Datatype

204

Successfully deleted

<<>>

400

ProblemDetail

403

ProblemDetail

404

ProblemDetail

500

ProblemDetail
Examples
HTTP Request
cURL Request
HTTP Response

3.1.3. GET /api/private/management/v2.0/organizations/{id}

Operation: getOrganizationById

Retrieves a specific organization by id

Getting organization by Id
Parameters
Body Parameter

Name

Description

Required

Default
Path Parameters

Name

Description

Required

Default

id

X

null
Return Type

Organization

Content Type

  • /

  • application/problem+json

  • application/json

Responses
Table 3. HTTP Response Codes

Code

Message

Datatype

200

Returns the organization

Organization

400

ProblemDetail

403

ProblemDetail

404

ProblemDetail

500

ProblemDetail
Examples
HTTP Request
cURL Request
HTTP Response

3.1.4. GET /api/private/management/v2.0/organizations/

Operation: getOrganizations

Retrieve list of all organizations

Getting all the organizations with paging
Parameters
Body Parameter

Name

Description

Required

Default
Query Parameters

Name

Description

Required

Default

page

Zero-based page index (0..N)

0

size

The size of the page to be returned

20

sort

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

null
Return Type

PageOrganization

Content Type

  • /

  • application/problem+json

  • application/json

Responses
Table 4. HTTP Response Codes

Code

Message

Datatype

200

Returns list of organizations

PageOrganization

400

ProblemDetail

403

ProblemDetail

500

ProblemDetail
Examples
HTTP Request
cURL Request
HTTP Response

3.1.5. PUT /api/private/management/v2.0/organizations/

Operation: updateOrganization

Update a organization

Update a organization
Parameters
Body Parameter

Name

Description

Required

Default

Organization

Organization

X
Return Type

Organization

Content Type

  • /

  • application/problem+json

  • application/json

Responses
Table 5. HTTP Response Codes

Code

Message

Datatype

200

Organization updated successfully

Organization

400

ProblemDetail

403

ProblemDetail

404

ProblemDetail

500

ProblemDetail
Request Content Type

  • application/json

Examples
HTTP Request
cURL Request
HTTP Response

4. Data Models

This section describes all data structures used in the API.

4.1. ErrorDetail

Name

Type

Required

Description

field

[String]

Name of the field that failed validation

message

[String]

Human-readable error message

rejectedValue

[oas_any_type_not_mapped]

code

[String]

Validation constraint code

4.2. Organization

Represents an organization in the booking system

4.2.1. type

Type of the organization

Value

VENUE

Name

Type

Required

Description

id

[Long]

Unique identifier for the organization

name

[String]

X

Name of the organization

publicKey

[UUID]

Public key used for authentication

privateKey

[UUID]

Private key used for authentication (hidden in toString)

domain

[String]

Domain associated with the organization

autologinEnabled

[Boolean]

Indicates if auto-login is enabled for this organization

appendDomainToLogin

[Boolean]

Indicates if domain should be appended to login credentials

type

[String]

Type of the organization

tenantId

[Long]

Identifier of the tenant

4.3. OrganizationWithUser

Represents a organization with user

4.3.1. type

Type of the organization

Value

VENUE

Name

Type

Required

Description

id

[Long]

Unique identifier for the organization

name

[String]

X

Name of the organization

publicKey

[UUID]

Public key used for authentication

privateKey

[UUID]

Private key used for authentication (hidden in toString)

domain

[String]

Domain associated with the organization

autologinEnabled

[Boolean]

Indicates if auto-login is enabled for this organization

appendDomainToLogin

[Boolean]

Indicates if domain should be appended to login credentials

type

[String]

Type of the organization

tenantId

[Long]

Identifier of the tenant

lastName

[String]

X

Last name of the user

firstName

[String]

X

First name of the user

password

[String]

X

Password of the user

email

[String]

X

Email of the user

4.4. PageOrganization

Name

Type

Required

Description

totalPages

[Integer]

totalElements

[Long]

pageable

PageableObject

first

[Boolean]

last

[Boolean]

size

[Integer]

content

List[[array]]

number

[Integer]

sort

SortObject

numberOfElements

[Integer]

empty

[Boolean]

4.5. PageableObject

Name

Type

Required

Description

paged

[Boolean]

pageNumber

[Integer]

pageSize

[Integer]

offset

[Long]

sort

SortObject

unpaged

[Boolean]

4.6. ProblemDetail

Name

Type

Required

Description

type

[String]

URI reference identifying the problem type

title

[String]

Human-readable summary of the error category

status

[oas_any_type_not_mapped]

detail

[String]

Human-readable explanation of the error

instance

[String]

URI of the specific occurrence

timestamp

[String]

ISO-8601 timestamp

path

[String]

Request path

errorCode

[String]

Machine-readable error code

errors

List[[array]]

Array of detailed field-level errors

4.7. ProblemDetailErrorsInner

Name

Type

Required

Description

field

[String]

Name of the field that failed validation

message

[String]

Human-readable error message

rejectedValue

[oas_any_type_not_mapped]

code

[String]

Validation constraint code

4.8. SortObject

Name

Type

Required

Description

sorted

[Boolean]

empty

[Boolean]

unsorted

[Boolean]

5. Additional Resources