Bynder TEA - Public API

{"openapi":"3.1.0","info":{"title":"TEA - Public API","description":"Public API for retrieving text content within Bynder.","contact":{},"version":"1.0.0"},"jsonSchemaDialect":"https://json-schema.org/draft/2020-12/schema","servers":[{"url":"https://$ACCOUNT.bynder.com/api/1/authoring","description":"The $ACCOUNT should be your assigned subdomain or replace the whole URL if you have a custom domain.","variables":{}}],"paths":{"/documents/{document_uuid}":{"get":{"tags":["Document"],"summary":"Get document","description":"Use this endpoint to retrieve your text content in CXUC. The `$ACCOUNT` is your assigned subdomain, or just replace the URL if you have a custom domain.","operationId":"getDocument","parameters":[{"name":"document_uuid","in":"path","description":"The UUID of the document to be actioned.","required":true,"style":"simple","schema":{"type":"string","contentEncoding":"uuid"}},{"name":"Accept","in":"header","description":"The Accept header must be set to application/vnd.api+json","style":"simple","schema":{"allOf":[{"$ref":"#/components/schemas/Accept"},{"description":"The Accept header must be set to application/vnd.api+json"}]}},{"name":"Authorization","in":"header","description":"The authorization header that is using the JWT token and the Bearer scheme.","required":true,"style":"simple","schema":{"pattern":"Bearer .+","type":"string"}},{"name":"Referer","in":"header","description":"The referer header is required to derive the calling module for permissions functionality.","style":"simple","schema":{"type":"string","examples":["https://account.example.com/guidelines/page/d4822bae-91ac-4cec-b392-9c5c1877f718"]}}],"responses":{"200":{"description":"A DocumentContent response","headers":{},"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/DocumentContentBody"}}}},"400":{"description":"Validation Error","headers":{},"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ErrorsObject"}}}},"403":{"description":"Permissions Error","headers":{},"content":{"application/vnd.api+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorsObject"},{"examples":[{"errors":[{"id":"req-adcaa568-7082-4cc8-9db9-9d78f1a3d95d","status":403,"code":"FORBIDDEN_ERROR","title":"ForbiddenError","detail":"Something went wrong"}]}]}],"contentMediaType":"application/vnd.api+json"},"examples":{"forbidden":{"summary":"Forbidden error","description":"Example of error properties when the error is a 403 forbidden response","value":{"errors":[{"id":"req-adcaa568-7082-4cc8-9db9-9d78f1a3d95d","status":403,"code":"FORBIDDEN_ERROR","title":"ForbiddenError","detail":"Something went wrong"}]}}}}}},"500":{"description":"Server Error","headers":{},"content":{"application/vnd.api+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorsObject"},{"examples":[{"errors":[{"id":"req-adcaa568-7082-4cc8-9db9-9d78f1a3d95d","status":500,"code":"UNKNOWN_ERROR","title":"UnknownError","detail":"Something went wrong"}]}]}],"contentMediaType":"application/vnd.api+json"},"examples":{"forbidden":{"summary":"Unknown Error","description":"Example of error properties when the error is a 500 error response","value":{"errors":[{"id":"req-adcaa568-7082-4cc8-9db9-9d78f1a3d95d","status":500,"code":"UNKNOWN_ERROR","title":"UnknownError","detail":"Something went wrong"}]}}}}}}},"deprecated":false,"security":[{"bearerAuth":[]}]},"parameters":[]}},"components":{"schemas":{"ErrorCode":{"title":"ErrorCode","enum":["VALIDATION_ERROR","SERIALIZATION_ERROR","UNKNOWN_ERROR","AUTHENTICATION_ERROR","MISSING_ERROR","FORBIDDEN_ERROR","STORAGE_API_ERROR"],"type":"string","description":"Machine readable error code","examples":["VALIDATION_ERROR"]},"JSONAPIresponseshapeschema.Itshouldincludedata.attributes":{"title":"JSONAPIresponseshapeschema.Itshouldincludedata.attributes","required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/Data"}}},"ErrorObject":{"title":"ErrorObject","required":["status","code","title","detail"],"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for this _instance_ of the error","examples":["req-adcaa568-7082-4cc8-9db9-9d78f1a3d95d"]},"status":{"type":"number","description":"The HTTP Status Code","examples":["400","500"]},"code":{"allOf":[{"$ref":"#/components/schemas/ErrorCode"},{"description":"Machine readable error code","examples":["VALIDATION_ERROR"]}]},"title":{"type":"string","description":"Human readable error title.","examples":["ValidationError"]},"detail":{"type":"string","description":"Human readable error details.","examples":["body/data/attributes must have required property 'html'"]},"meta":{"description":"An object of any arbitrary data. Record<string, unknown>"}}},"ErrorsObject":{"title":"ErrorsObject","required":["errors"],"type":"object","properties":{"errors":{"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/ErrorObject"},"description":""}}},"Resourcerepresentingthecontentinadocument":{"title":"Resourcerepresentingthecontentinadocument","required":["type","attributes"],"type":"object","properties":{"type":{"const":"document","type":"string"},"attributes":{"$ref":"#/components/schemas/Attributes"}}},"DocumentContentBody":{"title":"DocumentContentBody","required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/Resourcerepresentingthecontentinadocument1"}}},"Accept":{"title":"Accept","const":"application/vnd.api+json","type":"string"},"Attributes":{"title":"Attributes","type":"object","properties":{"document":{"type":"string","description":"ProseMirror JSON Object (https://prosemirror.net/docs/ref/#model.Document_Structure)","examples":[{"type":"doc","content":[{"type":"paragraph","content":[{"type":"text","text":"Hello world."}]}]}]},"html":{"type":"string","description":"HTML string","examples":["<p>Hello world!</p>"]},"documentGroupId":{"type":"string","description":"The group id to which the document belongs. This is used to group documents together.","examples":["group_id_1"]}}},"Data":{"title":"Data","required":["id","type"],"type":"object","properties":{"id":{"type":"string","description":"UUID identifier","contentEncoding":"uuid"},"type":{"type":"string","description":"Resource type"}}},"Resourcerepresentingthecontentinadocument1":{"title":"Resourcerepresentingthecontentinadocument1","required":["id","type","attributes"],"type":"object","properties":{"id":{"type":"string","description":"UUID identifier","contentEncoding":"uuid"},"type":{"const":"document","type":"string","description":"Resource type"},"attributes":{"$ref":"#/components/schemas/Attributes"}}}},"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"jwt"}}},"security":[],"tags":[{"name":"document","description":"Concerns a document entity, that is, a document for the widget"}]}