Search competitions
GET /v1/competitions
Compatibility policy · Changelog
Searches competitions by name, country, international flag and
discipline. Competitions carry no date; only editions do — year and
date filtering happens on the editions endpoint. name is trimmed, case-insensitive contains matching;
user input is matched literally. Only competitions with at least one
dated edition containing a class are returned.
Unknown query parameters are rejected with 422 validation_failed.
The page size is capped and defaulted at 100; a smaller page_size
is allowed and becomes bound to the traversal token, after which
page_size and sort overrides are rejected. Default sort is
name; use id for exhaustive traversal.
Each successful page, including an empty page (data: [],
total: 0), is charged at this operation's current price, which your
OpenAPI document (GET /v1/openapi.json) and your portal API
reference show. Errors are never
charged.
Parameters
| Field | Type | Description |
|---|---|---|
name | query · string | Competition name, trimmed case-insensitive contains matching, minimum two characters. Minimum length: |
country_iso_code | query · string | Exact competition country, uppercase ISO 3166-1 alpha-2. Pattern: |
international | query · boolean | Filter on international competitions. Omission means no filter. |
discipline | query · string | Discipline filter. Omission means all disciplines. Allowed values: |
sort | query · string | Sort profile. Allowed values: |
page_size | query · integer | Page size, capped at 100. Bound to the traversal token; rejected as an override once a traversal has begun. Default: |
page_token | query · string | Opaque signed continuation token from Once a traversal has begun, per-request |
X-Hippomundo-Freshness | header · string | Requests fresher data for this call. Allowed values: |
Hippomundo-Version | header · string | Optional pin to the API version your integration was built against.
The only accepted value is |
Idempotency-Key | header · string | Optional idempotency key for billable requests. Reuse by the same API
key with the same normalized request within 24 hours never creates a
second debit. A repeat within that window of a successful request
that was charged or used a free allowance is not charged again: it
answers with Maximum length: |
Response 200 · application/json
One page of competition search results.
| Field | Type | Description |
|---|---|---|
Body | CompetitionSearchPage | |
Header: Cache-Control | string · required | Always |
Header: Hippomundo-Charged-Milli-Credits | integer (int64) · required | The milli-credits this request debited from your balance, read from
the recorded charge; one credit is 1,000 milli-credits. Minimum: |
Header: Hippomundo-Data-Generation | string | Sandbox only. Names the copy of the sandbox data that answered this
request. The weekly data refresh replaces that copy and publishes a
new value, so a client that keeps sandbox data can key it on this
value. HTTP caches still may not store the response
( Pattern: |
Header: Hippomundo-Request-ID | string · required | Compact server-generated request identifier carried on every
response. On errors it equals the body |
Header: Idempotent-Replayed | string |
Allowed values: |
Header: X-RateLimit-Limit | integer | Request quota of the applied rate-limit window. The same rate-limit headers appear on successful authenticated responses. |
Header: X-RateLimit-Remaining | integer | Requests remaining in the applied rate-limit window. |
Related schemas: CompetitionSearchPage
Example
{
"data": [
{
"country_iso_code": "BE",
"discipline": "jumping",
"id": 3120,
"international": true,
"name": "CSI Grimbergen"
}
],
"has_more": false,
"next_page_token": null,
"total": 1
}Response 400 · application/problem+json
400 — one of the registered codes malformed_request, invalid_page_token, page_token_expired or unsupported_version; branch on the body code. Not retryable without changing the request. Uncharged.
| Field | Type | Description |
|---|---|---|
Body | Problem | RFC 9457 problem document used by every managed error response
under |
Header: Cache-Control | string · required | Always |
Header: Hippomundo-Request-ID | string · required | Compact server-generated request identifier carried on every
response. On errors it equals the body |
Related schemas: Problem
Page token is malformed or mismatched
{
"charged": false,
"code": "invalid_page_token",
"detail": "The supplied page token is not valid for this query and API key.",
"instance": "urn:hippomundo:request:01J5AR8Q2K0000000000000001",
"request_id": "01J5AR8Q2K0000000000000001",
"retryable": false,
"status": 400,
"title": "Invalid page token",
"type": "https://enterprise.hippomundo.com/docs/errors/invalid_page_token"
}Request syntax cannot be parsed
{
"charged": false,
"code": "malformed_request",
"detail": "The request could not be parsed.",
"instance": "urn:hippomundo:request:01J5AR8Q2K0000000000000000",
"request_id": "01J5AR8Q2K0000000000000000",
"retryable": false,
"status": 400,
"title": "Malformed request",
"type": "https://enterprise.hippomundo.com/docs/errors/malformed_request"
}Page token past its public expiry
{
"charged": false,
"code": "page_token_expired",
"detail": "The traversal token has expired; restart from page one.",
"instance": "urn:hippomundo:request:01J5AR8Q2K0000000000000002",
"request_id": "01J5AR8Q2K0000000000000002",
"retryable": false,
"status": 400,
"title": "Page token expired",
"type": "https://enterprise.hippomundo.com/docs/errors/page_token_expired"
}Hippomundo-Version is not supported
{
"charged": false,
"code": "unsupported_version",
"detail": "The requested API version is not supported.",
"instance": "urn:hippomundo:request:01J5AR8Q2K0000000000000003",
"request_id": "01J5AR8Q2K0000000000000003",
"retryable": false,
"status": 400,
"title": "Unsupported version",
"type": "https://enterprise.hippomundo.com/docs/errors/unsupported_version"
}Response 401 · application/problem+json
401 invalid_api_key — the API key is missing, invalid, revoked or otherwise unusable; the states are deliberately indistinguishable. Not retryable without different credentials. Uncharged.
| Field | Type | Description |
|---|---|---|
Body | Problem | RFC 9457 problem document used by every managed error response
under |
Header: Cache-Control | string · required | Always |
Header: Hippomundo-Request-ID | string · required | Compact server-generated request identifier carried on every
response. On errors it equals the body |
Header: WWW-Authenticate | string · required | Always |
Related schemas: Problem
API key missing, invalid, revoked or otherwise unusable
{
"charged": false,
"code": "invalid_api_key",
"detail": "The request was not authenticated.",
"instance": "urn:hippomundo:request:01J5AR8Q2K0000000000000004",
"request_id": "01J5AR8Q2K0000000000000004",
"retryable": false,
"status": 401,
"title": "Invalid API key",
"type": "https://enterprise.hippomundo.com/docs/errors/invalid_api_key"
}Response 402 · application/problem+json
402 — one of the registered codes insufficient_credits, account_in_arrears or api_key_credit_cap_reached; branch on the body code because the remediation differs. Top up after insufficient_credits and settle the negative balance after account_in_arrears; neither is retryable until remediated. api_key_credit_cap_reached means the request would take this API key past the credit cap its owner set for each UTC day or UTC calendar month. A request that costs less may still succeed. It is retryable: Retry-After gives the seconds until the next period starts and the full cap is available again, and the owner can also raise or remove the cap in the portal. The body never states balances, caps or pricing internals; the portal and usage API are the authenticated source for financial detail. Uncharged.
| Field | Type | Description |
|---|---|---|
Body | Problem | RFC 9457 problem document used by every managed error response
under |
Header: Cache-Control | string · required | Always |
Header: Hippomundo-Request-ID | string · required | Compact server-generated request identifier carried on every
response. On errors it equals the body |
Header: Retry-After | integer | Seconds to wait before retrying. Required on Minimum: |
Related schemas: Problem
Negative balance blocks metered calls
{
"charged": false,
"code": "account_in_arrears",
"detail": "A negative balance blocks metered calls until it is settled.",
"instance": "urn:hippomundo:request:01J5AR8Q2K0000000000000006",
"request_id": "01J5AR8Q2K0000000000000006",
"retryable": false,
"status": 402,
"title": "Account in arrears",
"type": "https://enterprise.hippomundo.com/docs/errors/account_in_arrears"
}The request would take the API key past its credit cap for the current period
{
"charged": false,
"code": "api_key_credit_cap_reached",
"detail": "This request would take the API key past the credit cap its owner set for the current period. A request that costs less may still succeed, and the full cap is available again when the next period starts.",
"instance": "urn:hippomundo:request:01J5AR8Q2K000000000000000M",
"request_id": "01J5AR8Q2K000000000000000M",
"retryable": true,
"status": 402,
"title": "API key credit cap reached",
"type": "https://enterprise.hippomundo.com/docs/errors/api_key_credit_cap_reached"
}Spendable credits cannot cover the maximum authorized cost
{
"charged": false,
"code": "insufficient_credits",
"detail": "The account does not hold enough spendable credits for this request.",
"instance": "urn:hippomundo:request:01J5AR8Q2K0000000000000005",
"request_id": "01J5AR8Q2K0000000000000005",
"retryable": false,
"status": 402,
"title": "Insufficient credits",
"type": "https://enterprise.hippomundo.com/docs/errors/insufficient_credits"
}Response 403 · application/problem+json
403 endpoint_not_entitled — the authenticated Customer lacks a required entitlement for a discoverable public endpoint it has not purchased. Private endpoints never return 403; they return 404 not_found. Not retryable without purchasing the entitlement. Uncharged.
| Field | Type | Description |
|---|---|---|
Body | Problem | RFC 9457 problem document used by every managed error response
under |
Header: Cache-Control | string · required | Always |
Header: Hippomundo-Request-ID | string · required | Compact server-generated request identifier carried on every
response. On errors it equals the body |
Related schemas: Problem
Public endpoint not purchased
{
"charged": false,
"code": "endpoint_not_entitled",
"detail": "The account is not entitled to this endpoint.",
"instance": "urn:hippomundo:request:01J5AR8Q2K0000000000000007",
"request_id": "01J5AR8Q2K0000000000000007",
"retryable": false,
"status": 403,
"title": "Endpoint not entitled",
"type": "https://enterprise.hippomundo.com/docs/errors/endpoint_not_entitled"
}Response 406 · application/problem+json
406 not_acceptable — the Accept header excludes application/json, the media type of every successful response. Omit the header or send one that admits application/json, for example application/json, application/* or */*. Error responses are always application/problem+json. Not retryable without changing the Accept header. Uncharged.
| Field | Type | Description |
|---|---|---|
Body | Problem | RFC 9457 problem document used by every managed error response
under |
Header: Cache-Control | string · required | Always |
Header: Hippomundo-Request-ID | string · required | Compact server-generated request identifier carried on every
response. On errors it equals the body |
Related schemas: Problem
Requested response media type unsupported
{
"charged": false,
"code": "not_acceptable",
"detail": "The requested response media type is not supported.",
"instance": "urn:hippomundo:request:01J5AR8Q2K000000000000000A",
"request_id": "01J5AR8Q2K000000000000000A",
"retryable": false,
"status": 406,
"title": "Not acceptable",
"type": "https://enterprise.hippomundo.com/docs/errors/not_acceptable"
}Response 409 · application/problem+json
409 idempotency_conflict — the same Customer or key reused an idempotency key for a different normalized request within 24 hours of a success under that key that was charged or used a free allowance. Not retryable with the same key; use a new idempotency key for a new request. Uncharged.
| Field | Type | Description |
|---|---|---|
Body | Problem | RFC 9457 problem document used by every managed error response
under |
Header: Cache-Control | string · required | Always |
Header: Hippomundo-Request-ID | string · required | Compact server-generated request identifier carried on every
response. On errors it equals the body |
Related schemas: Problem
Idempotency key reused for a different request
{
"charged": false,
"code": "idempotency_conflict",
"detail": "This idempotency key was already used for a different request.",
"instance": "urn:hippomundo:request:01J5AR8Q2K000000000000000B",
"request_id": "01J5AR8Q2K000000000000000B",
"retryable": false,
"status": 409,
"title": "Idempotency conflict",
"type": "https://enterprise.hippomundo.com/docs/errors/idempotency_conflict"
}Response 422 · application/problem+json
422 validation_failed — parsed public inputs fail the documented schema or combination rules. errors lists up to 20 field-level items in request-field order, without messages or rejected values; errors_truncated may be true when more exist. Not retryable without correcting the request. Uncharged.
| Field | Type | Description |
|---|---|---|
Body | Problem | RFC 9457 problem document used by every managed error response
under |
Header: Cache-Control | string · required | Always |
Header: Hippomundo-Request-ID | string · required | Compact server-generated request identifier carried on every
response. On errors it equals the body |
Related schemas: Problem
Parsed public inputs fail the documented rules
{
"charged": false,
"code": "validation_failed",
"detail": "One or more request parameters are invalid.",
"errors": [
{
"code": "invalid_format",
"field": "date_from",
"location": "query"
}
],
"instance": "urn:hippomundo:request:01J5AR8Q2K000000000000000E",
"request_id": "01J5AR8Q2K000000000000000E",
"retryable": false,
"status": 422,
"title": "Request validation failed",
"type": "https://enterprise.hippomundo.com/docs/errors/validation_failed"
}Response 429 · application/problem+json
429 rate_limit_exceeded — the Customer or key rate policy rejected the request. Retryable after waiting at least Retry-After; preserve the same idempotency key for a billable retry. Carries the same rate-limit headers used on successful authenticated responses. Uncharged.
| Field | Type | Description |
|---|---|---|
Body | Problem | RFC 9457 problem document used by every managed error response
under |
Header: Cache-Control | string · required | Always |
Header: Hippomundo-Request-ID | string · required | Compact server-generated request identifier carried on every
response. On errors it equals the body |
Header: Retry-After | integer | Seconds to wait before retrying. Required on Minimum: |
Header: X-RateLimit-Limit | integer | Request quota of the applied rate-limit window. The same rate-limit headers appear on successful authenticated responses. |
Header: X-RateLimit-Remaining | integer | Requests remaining in the applied rate-limit window. |
Related schemas: Problem
Rate policy rejected the request
{
"charged": false,
"code": "rate_limit_exceeded",
"detail": "The rate limit for this API key was exceeded.",
"instance": "urn:hippomundo:request:01J5AR8Q2K000000000000000F",
"request_id": "01J5AR8Q2K000000000000000F",
"retryable": true,
"status": 429,
"title": "Rate limit exceeded",
"type": "https://enterprise.hippomundo.com/docs/errors/rate_limit_exceeded"
}Response 500 · application/problem+json
500 internal_error — an unexpected Hippomundo failure with no safer public classification. Retryability is occurrence-specific; honor the body retryable field, use exponential backoff with jitter, preserve the idempotency key and report persistent failures with the request_id. Uncharged.
| Field | Type | Description |
|---|---|---|
Body | Problem | RFC 9457 problem document used by every managed error response
under |
Header: Cache-Control | string · required | Always |
Header: Hippomundo-Request-ID | string · required | Compact server-generated request identifier carried on every
response. On errors it equals the body |
Related schemas: Problem
Unexpected failure with no safer classification
{
"charged": false,
"code": "internal_error",
"detail": "An unexpected internal error occurred.",
"instance": "urn:hippomundo:request:01J5AR8Q2K000000000000000G",
"request_id": "01J5AR8Q2K000000000000000G",
"retryable": false,
"status": 500,
"title": "Internal error",
"type": "https://enterprise.hippomundo.com/docs/errors/internal_error"
}Response 502 · application/problem+json
502 dependency_error — a required managed dependency returned an invalid or failing response. Retryability is occurrence-specific; honor the body retryable field. Uncharged.
| Field | Type | Description |
|---|---|---|
Body | Problem | RFC 9457 problem document used by every managed error response
under |
Header: Cache-Control | string · required | Always |
Header: Hippomundo-Request-ID | string · required | Compact server-generated request identifier carried on every
response. On errors it equals the body |
Related schemas: Problem
A managed dependency returned an invalid or failing response
{
"charged": false,
"code": "dependency_error",
"detail": "A required internal dependency failed.",
"instance": "urn:hippomundo:request:01J5AR8Q2K000000000000000H",
"request_id": "01J5AR8Q2K000000000000000H",
"retryable": false,
"status": 502,
"title": "Dependency error",
"type": "https://enterprise.hippomundo.com/docs/errors/dependency_error"
}Response 503 · application/problem+json
503 service_unavailable — the service or a required ledger or dependency is temporarily unavailable. Retryable; honor Retry-After when present and use exponential backoff with jitter. Uncharged.
| Field | Type | Description |
|---|---|---|
Body | Problem | RFC 9457 problem document used by every managed error response
under |
Header: Cache-Control | string · required | Always |
Header: Hippomundo-Request-ID | string · required | Compact server-generated request identifier carried on every
response. On errors it equals the body |
Header: Retry-After | integer | Seconds to wait before retrying. Required on Minimum: |
Related schemas: Problem
Service temporarily unavailable
{
"charged": false,
"code": "service_unavailable",
"detail": "The service is temporarily unavailable.",
"instance": "urn:hippomundo:request:01J5AR8Q2K000000000000000J",
"request_id": "01J5AR8Q2K000000000000000J",
"retryable": true,
"status": 503,
"title": "Service unavailable",
"type": "https://enterprise.hippomundo.com/docs/errors/service_unavailable"
}Response 504 · application/problem+json
504 dependency_timeout — a required dependency exceeded its deadline. Retryable with exponential backoff and jitter; preserve the idempotency key so a billable retry cannot double-charge. Uncharged.
| Field | Type | Description |
|---|---|---|
Body | Problem | RFC 9457 problem document used by every managed error response
under |
Header: Cache-Control | string · required | Always |
Header: Hippomundo-Request-ID | string · required | Compact server-generated request identifier carried on every
response. On errors it equals the body |
Related schemas: Problem
A dependency exceeded its deadline
{
"charged": false,
"code": "dependency_timeout",
"detail": "A required internal dependency timed out.",
"instance": "urn:hippomundo:request:01J5AR8Q2K000000000000000K",
"request_id": "01J5AR8Q2K000000000000000K",
"retryable": true,
"status": 504,
"title": "Dependency timeout",
"type": "https://enterprise.hippomundo.com/docs/errors/dependency_timeout"
}OpenAPI definition
Related schemas: CompetitionSearchPage
Complete OpenAPI definition
{
"description": "Searches competitions by name, country, `international` flag and\ndiscipline. Competitions carry no date; only editions do — year and\ndate filtering happens on the editions endpoint. `name` is trimmed, case-insensitive contains matching;\nuser input is matched literally. Only competitions with at least one\ndated edition containing a class are returned.\n\nUnknown query parameters are rejected with `422 validation_failed`.\nThe page size is capped and defaulted at 100; a smaller `page_size`\nis allowed and becomes bound to the traversal token, after which\n`page_size` and `sort` overrides are rejected. Default sort is\n`name`; use `id` for exhaustive traversal.\n\nEach successful page, including an empty page (`data: []`,\n`total: 0`), is charged at this operation's current price, which your\nOpenAPI document (`GET /v1/openapi.json`) and your portal API\nreference show. Errors are never\ncharged.\n",
"operationId": "searchCompetitions",
"parameters": [
{
"description": "Competition name, trimmed case-insensitive contains matching, minimum two characters.",
"in": "query",
"name": "name",
"schema": {
"maxLength": 100,
"minLength": 2,
"type": "string"
}
},
{
"description": "Exact competition country, uppercase ISO 3166-1 alpha-2.",
"in": "query",
"name": "country_iso_code",
"schema": {
"pattern": "^[A-Z]{2}$",
"type": "string"
}
},
{
"description": "Filter on international competitions. Omission means no filter.",
"in": "query",
"name": "international",
"schema": {
"type": "boolean"
}
},
{
"description": "Discipline filter. Omission means all disciplines.",
"in": "query",
"name": "discipline",
"schema": {
"enum": [
"jumping",
"dressage",
"eventing"
],
"type": "string"
}
},
{
"description": "Sort profile. `id` is recommended for exhaustive traversal. Rejected as an override once a traversal has begun.",
"in": "query",
"name": "sort",
"schema": {
"default": "name",
"enum": [
"name",
"id"
],
"type": "string"
}
},
{
"description": "Page size, capped at 100. Bound to the traversal token; rejected as an override once a traversal has begun.",
"in": "query",
"name": "page_size",
"schema": {
"default": 100,
"maximum": 100,
"minimum": 1,
"type": "integer"
}
},
{
"$ref": "#/components/parameters/PageToken"
},
{
"$ref": "#/components/parameters/FreshnessOverride"
},
{
"$ref": "#/components/parameters/VersionHeader"
},
{
"$ref": "#/components/parameters/IdempotencyKey"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"data": [
{
"country_iso_code": "BE",
"discipline": "jumping",
"id": 3120,
"international": true,
"name": "CSI Grimbergen"
}
],
"has_more": false,
"next_page_token": null,
"total": 1
},
"schema": {
"$ref": "#/components/schemas/CompetitionSearchPage"
}
}
},
"description": "One page of competition search results.",
"headers": {
"Cache-Control": {
"$ref": "#/components/headers/CacheControlPrivateNoStore"
},
"Hippomundo-Charged-Milli-Credits": {
"$ref": "#/components/headers/HippomundoChargedMilliCredits"
},
"Hippomundo-Data-Generation": {
"$ref": "#/components/headers/HippomundoDataGeneration"
},
"Hippomundo-Request-ID": {
"$ref": "#/components/headers/HippomundoRequestId"
},
"Idempotent-Replayed": {
"$ref": "#/components/headers/IdempotentReplayed"
},
"X-RateLimit-Limit": {
"$ref": "#/components/headers/RateLimitLimit"
},
"X-RateLimit-Remaining": {
"$ref": "#/components/headers/RateLimitRemaining"
}
}
},
"400": {
"$ref": "#/components/responses/BadRequest"
},
"401": {
"$ref": "#/components/responses/InvalidApiKey"
},
"402": {
"$ref": "#/components/responses/PaymentRequired"
},
"403": {
"$ref": "#/components/responses/EndpointNotEntitled"
},
"406": {
"$ref": "#/components/responses/NotAcceptable"
},
"409": {
"$ref": "#/components/responses/IdempotencyConflict"
},
"422": {
"$ref": "#/components/responses/ValidationFailed"
},
"429": {
"$ref": "#/components/responses/RateLimitExceeded"
},
"500": {
"$ref": "#/components/responses/InternalError"
},
"502": {
"$ref": "#/components/responses/DependencyError"
},
"503": {
"$ref": "#/components/responses/ServiceUnavailable"
},
"504": {
"$ref": "#/components/responses/DependencyTimeout"
}
},
"summary": "Search competitions",
"tags": [
"search"
]
}