API reference

Feed API Endpoint

PropertyValue
Base URLhttps://feed.api.eu1.scalar.zf.com
Endpoint/v1/feed/{feedId}
HTTP MethodGET
Content-Typeapplication/json
Rate LimitXLarge (reviewed for extreme usage patterns)
Featuredatahub-subscription

Request Parameters

Path Parameters

ParameterTypeRequiredDescription
feedIdstringYesUnique identifier for your Feed subscription (UUID format)

Query Parameters

ParameterTypeRequiredDefaultMinMaxDescription
limitintegerNo100100250Number of records to return in single request

Request Headers

HeaderRequiredExample
AuthorizationYesBearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
Content-TypeNoapplication/json

Response Schema

The Feed API returns data in a standardized JSON structure:

{
  "items": [
    {
      "eventType": "string",
      "eventVersion": "integer",
      "eventData": {
        // Event-specific payload
      }
    }
  ],
  "hasNext": "boolean"
}

Response Codes

Status CodeMeaningDescription
200 OKSuccessFeed data retrieved successfully
400 Bad RequestInvalid RequestInvalid parameters or malformed request
401 UnauthorizedAuth FailedMissing or invalid authorization token
403 ForbiddenAccess DeniedIntegrator lacks permission for this feed
404 Not FoundFeed InactiveFeed subscription is deactivated or doesn't exist
429 Too Many RequestsRate LimitedRequest rate limit exceeded
500 Server ErrorServer IssueInternal server error; retry after delay
503 Service UnavailableService DownService temporarily unavailable; retry after delay