In this page
    API versioning

    The latest version of the Content Management API is version 3. On every request you perform, you MUST specify the API version with the X-Api-Version header:

    curl \
    -H 'Authorization: Bearer <YOUR-API-TOKEN>' \
    -H 'Accept: application/json' \
    -H 'X-Api-Version: 3' \

    Breaking changes

    The guarantee that the Content Management API offers is to introduce breaking changes only when the API version changes.

    It is considered a "breaking change":

    • a change in path for an existing endpoint;

    • a change in the format of the request/response payload compared to what stated in this API reference;

    We reserve the right to change the format of payloads without changing API version only when:

    • an attribute/relationship that previously was mandatory in a HTTP request becomes optional;

    • a new optional attribute/relationship is introduced in a HTTP request;

    • a new attribute/relationship is introduced in a HTTP response;

    • a synchronous endpoint becomes asynchronous, but the job result has exactly the same signature as the old synchronous endpoint.

    In other words, no fields will ever be removed from the responses, but new ones might be added if they do not break former behaviours.