REST API Basics¶

This page describes common REST API request and response conventions.

Before You Call APIs¶

Authenticate first to obtain an API bearer token, then include that token on your requests.

See Authentication > API Authentication.

Required API Headers¶

All REST API requests should include:

Header	Required	Purpose
`Authorization: Bearer <token>`	Yes	OAuth access token for API access
`X-Tenant-Id: <tenant-id>`	Yes	Routes request to your tenant/system instance

Example:

GET /api/v1/exhibitor/event/{eventId}?Page=1&ItemsPerPage=20
Authorization: Bearer <api_access_token>
X-Tenant-Id: <tenant-id>
Accept: application/json

Pagination Conventions¶

Collection endpoints use page-based pagination.

Query parameters:

Parameter	Description
`Page`	Page number to retrieve (default `1`)
`ItemsPerPage`	Items per page (default `50`, max `50`)

Paginated Response Wrapper¶

{
  "paginationMetadata": {
    "currentPage": 1,
    "totalCount": 140,
    "totalPages": 7,
    "hasPreviousPage": false,
    "hasNextPage": true,
    "itemsPerPage": 20
  },
  "data": []
}