The Juo Admin API provides programmatic access to manage subscription resources. This RESTful API allows administrators to interact with subscriptions, customers, and other Juo entities.
All API requests must include an API key in the X-Juo-Admin-Api-Key
header. Tokens can be generated in the Juo admin interface. Keep your API keys secure and never share them.
The API uses cursor-based pagination to handle large result sets. Navigation links are provided in the Link
response header, containing URLs for the next and previous pages.
The amount of results per page can be set from 1-100 with the limit
query parameter where applicable:
Results can be sorted using the sort
query parameter. Multiple sort criteria can be combined using commas.
Sortable fields are the same as the filterable fields on a resource, there is a special rank
field that can be always used whenever search query includes a term not bound to a specific field.
Resources can be searched / filtered by an expressive query syntax.
The search grammar is expressed in EBNF. It uses the following terminal symbols:
Symbol | Description |
---|---|
_ | Optional whitespace |
__ | Mandatory whitespace |
field | An identifier ([a-z][a-zA-Z]* ) |
value | An identifier, single quoted string or double quoted string |
The syntax can be expressed with the following grammar:
It lets you to form advanced logical queries, some examples below:
Below you can find the meaning of each available operator:
Operator | Description |
---|---|
: | Equal |
:> | Greater than |
:>= | Greater than or equal |
:< | Less than |
:<= | Less than or equal |
The API implements a token bucket rate-limiting strategy to ensure fair usage. Each API token has a bucket that fills at a constant rate. API calls consume tokens from the bucket. When the bucket is empty, requests will be rejected until it refills.
Rate limit information is included in the response headers:
The Juo Admin API provides programmatic access to manage subscription resources. This RESTful API allows administrators to interact with subscriptions, customers, and other Juo entities.
All API requests must include an API key in the X-Juo-Admin-Api-Key
header. Tokens can be generated in the Juo admin interface. Keep your API keys secure and never share them.
The API uses cursor-based pagination to handle large result sets. Navigation links are provided in the Link
response header, containing URLs for the next and previous pages.
The amount of results per page can be set from 1-100 with the limit
query parameter where applicable:
Results can be sorted using the sort
query parameter. Multiple sort criteria can be combined using commas.
Sortable fields are the same as the filterable fields on a resource, there is a special rank
field that can be always used whenever search query includes a term not bound to a specific field.
Resources can be searched / filtered by an expressive query syntax.
The search grammar is expressed in EBNF. It uses the following terminal symbols:
Symbol | Description |
---|---|
_ | Optional whitespace |
__ | Mandatory whitespace |
field | An identifier ([a-z][a-zA-Z]* ) |
value | An identifier, single quoted string or double quoted string |
The syntax can be expressed with the following grammar:
It lets you to form advanced logical queries, some examples below:
Below you can find the meaning of each available operator:
Operator | Description |
---|---|
: | Equal |
:> | Greater than |
:>= | Greater than or equal |
:< | Less than |
:<= | Less than or equal |
The API implements a token bucket rate-limiting strategy to ensure fair usage. Each API token has a bucket that fills at a constant rate. API calls consume tokens from the bucket. When the bucket is empty, requests will be rejected until it refills.
Rate limit information is included in the response headers: