{ "info": { "description": "External API for reading organizations.", "title": "Talque Organization API", "version": "1.0.0" }, "paths": { "/api/v1/org/read": { "post": { "summary": "Read organizations by ID", "description": "Looks up one or more organizations by their IDs.", "parameters": [ { "name": "X-TQ-CLIENT-ID", "in": "header", "required": false, "schema": { "type": "string" }, "description": "The API client ID for authentication." }, { "name": "X-TQ-SECRET", "in": "header", "required": false, "schema": { "type": "string" }, "description": "The API client secret for authentication." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "orgIdList": { "type": "array", "items": { "type": "string" }, "description": "List of organization IDs to look up." } }, "required": [ "orgIdList" ] } } } }, "responses": { "200": { "description": "Lookup completed (individual organizations may still be not found)", "content": { "application/json": { "schema": { "type": "object", "properties": { "orgById": { "type": "object", "additionalProperties": { "type": "object", "properties": { "success": { "type": "boolean", "description": "Whether the organization was found." }, "reason": { "type": "string", "description": "Machine-readable result code." }, "model": { "type": [ "object", "null" ], "properties": { "orgId": { "type": "string", "description": "The unique identifier of the organization." }, "name": { "$schema": "http://json-schema.org/draft-04/schema", "type": "object", "properties": { "DE_DE": { "type": "string" }, "EN_US": { "type": "string" }, "FR_FR": { "type": "string" }, "ES_ES": { "type": "string" }, "PT_PT": { "type": "string" }, "ZH_CN": { "type": "string" }, "UK_UA": { "type": "string" }, "AR_EG": { "type": "string" }, "RU_RU": { "type": "string" }, "FA_IR": { "type": "string" }, "NL_NL": { "type": "string" } }, "additionalProperties": false, "description": "Organization name." }, "description": { "$schema": "http://json-schema.org/draft-04/schema", "type": "object", "properties": { "DE_DE": { "type": "string" }, "EN_US": { "type": "string" }, "FR_FR": { "type": "string" }, "ES_ES": { "type": "string" }, "PT_PT": { "type": "string" }, "ZH_CN": { "type": "string" }, "UK_UA": { "type": "string" }, "AR_EG": { "type": "string" }, "RU_RU": { "type": "string" }, "FA_IR": { "type": "string" }, "NL_NL": { "type": "string" } }, "additionalProperties": false, "description": "Organization description." }, "descriptionHtml": { "$schema": "http://json-schema.org/draft-04/schema", "type": [ "object", "null" ], "properties": { "DE_DE": { "type": "string" }, "EN_US": { "type": "string" }, "FR_FR": { "type": "string" }, "ES_ES": { "type": "string" }, "PT_PT": { "type": "string" }, "ZH_CN": { "type": "string" }, "UK_UA": { "type": "string" }, "AR_EG": { "type": "string" }, "RU_RU": { "type": "string" }, "FA_IR": { "type": "string" }, "NL_NL": { "type": "string" } }, "additionalProperties": false, "description": "HTML description." }, "text": { "$schema": "http://json-schema.org/draft-04/schema", "type": "object", "properties": { "DE_DE": { "type": "string" }, "EN_US": { "type": "string" }, "FR_FR": { "type": "string" }, "ES_ES": { "type": "string" }, "PT_PT": { "type": "string" }, "ZH_CN": { "type": "string" }, "UK_UA": { "type": "string" }, "AR_EG": { "type": "string" }, "RU_RU": { "type": "string" }, "FA_IR": { "type": "string" }, "NL_NL": { "type": "string" } }, "additionalProperties": false, "description": "Additional text." }, "textHtml": { "$schema": "http://json-schema.org/draft-04/schema", "type": [ "object", "null" ], "properties": { "DE_DE": { "type": "string" }, "EN_US": { "type": "string" }, "FR_FR": { "type": "string" }, "ES_ES": { "type": "string" }, "PT_PT": { "type": "string" }, "ZH_CN": { "type": "string" }, "UK_UA": { "type": "string" }, "AR_EG": { "type": "string" }, "RU_RU": { "type": "string" }, "FA_IR": { "type": "string" }, "NL_NL": { "type": "string" } }, "additionalProperties": false, "description": "HTML text." }, "occurs": { "type": [ "object", "array", "null" ], "description": "Event date ranges." }, "openingHours": { "$schema": "http://json-schema.org/draft-04/schema", "type": "object", "properties": { "DE_DE": { "type": "string" }, "EN_US": { "type": "string" }, "FR_FR": { "type": "string" }, "ES_ES": { "type": "string" }, "PT_PT": { "type": "string" }, "ZH_CN": { "type": "string" }, "UK_UA": { "type": "string" }, "AR_EG": { "type": "string" }, "RU_RU": { "type": "string" }, "FA_IR": { "type": "string" }, "NL_NL": { "type": "string" } }, "additionalProperties": false, "description": "Opening hours." }, "location": { "$schema": "http://json-schema.org/draft-04/schema", "type": "object", "properties": { "DE_DE": { "type": "string" }, "EN_US": { "type": "string" }, "FR_FR": { "type": "string" }, "ES_ES": { "type": "string" }, "PT_PT": { "type": "string" }, "ZH_CN": { "type": "string" }, "UK_UA": { "type": "string" }, "AR_EG": { "type": "string" }, "RU_RU": { "type": "string" }, "FA_IR": { "type": "string" }, "NL_NL": { "type": "string" } }, "additionalProperties": false, "description": "Event location." }, "building": { "$schema": "http://json-schema.org/draft-04/schema", "type": "object", "properties": { "DE_DE": { "type": "string" }, "EN_US": { "type": "string" }, "FR_FR": { "type": "string" }, "ES_ES": { "type": "string" }, "PT_PT": { "type": "string" }, "ZH_CN": { "type": "string" }, "UK_UA": { "type": "string" }, "AR_EG": { "type": "string" }, "RU_RU": { "type": "string" }, "FA_IR": { "type": "string" }, "NL_NL": { "type": "string" } }, "additionalProperties": false, "description": "Building name." }, "city": { "$schema": "http://json-schema.org/draft-04/schema", "type": "object", "properties": { "DE_DE": { "type": "string" }, "EN_US": { "type": "string" }, "FR_FR": { "type": "string" }, "ES_ES": { "type": "string" }, "PT_PT": { "type": "string" }, "ZH_CN": { "type": "string" }, "UK_UA": { "type": "string" }, "AR_EG": { "type": "string" }, "RU_RU": { "type": "string" }, "FA_IR": { "type": "string" }, "NL_NL": { "type": "string" } }, "additionalProperties": false, "description": "City." }, "country": { "type": [ "string", "null" ], "description": "ISO country code." }, "url": { "$schema": "http://json-schema.org/draft-04/schema", "type": "object", "properties": { "DE_DE": { "type": "string" }, "EN_US": { "type": "string" }, "FR_FR": { "type": "string" }, "ES_ES": { "type": "string" }, "PT_PT": { "type": "string" }, "ZH_CN": { "type": "string" }, "UK_UA": { "type": "string" }, "AR_EG": { "type": "string" }, "RU_RU": { "type": "string" }, "FA_IR": { "type": "string" }, "NL_NL": { "type": "string" } }, "additionalProperties": false, "description": "Website URL." }, "ticketingUrl": { "$schema": "http://json-schema.org/draft-04/schema", "type": "object", "properties": { "DE_DE": { "type": "string" }, "EN_US": { "type": "string" }, "FR_FR": { "type": "string" }, "ES_ES": { "type": "string" }, "PT_PT": { "type": "string" }, "ZH_CN": { "type": "string" }, "UK_UA": { "type": "string" }, "AR_EG": { "type": "string" }, "RU_RU": { "type": "string" }, "FA_IR": { "type": "string" }, "NL_NL": { "type": "string" } }, "additionalProperties": false, "description": "Ticketing URL." }, "photo": { "type": [ "string", "null" ], "description": "Organization photo URL." }, "logo": { "type": [ "string", "null" ], "description": "Organization logo URL." }, "background": { "type": [ "string", "null" ], "description": "Background image URL." }, "splashscreen": { "type": [ "string", "null" ], "description": "Splash screen URL." }, "banner": { "type": [ "string", "null" ], "description": "Banner URL." }, "teaser": { "type": [ "string", "null" ], "description": "Teaser URL." }, "mtime": { "type": "integer", "description": "Last modification time (milliseconds since epoch)." }, "agencyTags": { "type": "array", "items": { "type": "string" }, "description": "Agency classification tags." }, "locationTags": { "type": "array", "items": { "type": "string" }, "description": "Location tags." }, "isHighlightEnabled": { "type": "boolean", "description": "Whether highlights are enabled." }, "formatLabels": { "type": [ "object", "null" ], "description": "Lecture format labels." }, "topicLabels": { "type": [ "object", "null" ], "description": "Topic labels." }, "categoryLabels": { "type": [ "object", "null" ], "description": "Category labels." }, "tagLabels": { "type": [ "object", "null" ], "description": "Tag labels." }, "timezone": { "type": "string", "description": "Timezone identifier." }, "locales": { "type": "array", "items": { "type": "string" }, "description": "Supported locales." }, "gallery": { "type": [ "object", "null" ], "description": "Photo gallery." }, "customFields": { "type": [ "object", "null" ], "description": "Custom field definitions." }, "places": { "type": "array", "items": { "type": "string" }, "description": "Associated place IDs." }, "extId": { "type": [ "string", "null" ], "description": "External identifier." } }, "required": [ "orgId", "name", "mtime", "agencyTags", "locationTags", "isHighlightEnabled", "formatLabels", "topicLabels", "categoryLabels", "tagLabels", "timezone", "locales", "gallery", "customFields", "places" ], "description": "The organization data, or null if not found." } }, "required": [ "success", "reason", "model" ] }, "description": "Map from organization ID to its result." } }, "required": [ "orgById" ] } } } }, "400": { "description": "Bad request (e.g., missing or invalid fields)" }, "403": { "description": "Forbidden" } } } }, "/api/v1/org/list": { "post": { "summary": "List organizations for an agency", "description": "Returns public organizations for the authenticated agency.", "parameters": [ { "name": "X-TQ-CLIENT-ID", "in": "header", "required": false, "schema": { "type": "string" }, "description": "The API client ID for authentication." }, { "name": "X-TQ-SECRET", "in": "header", "required": false, "schema": { "type": "string" }, "description": "The API client secret for authentication." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "limit": { "type": "integer", "description": "Maximum number of organizations to return." }, "cursor": { "type": [ "string", "null" ], "description": "Pagination cursor from a previous response." } }, "required": [] } } } }, "responses": { "200": { "description": "List of organizations", "content": { "application/json": { "schema": { "type": "object", "properties": { "organizations": { "type": "array", "items": { "type": "object", "properties": { "orgId": { "type": "string", "description": "The unique identifier of the organization." }, "name": { "$schema": "http://json-schema.org/draft-04/schema", "type": "object", "properties": { "DE_DE": { "type": "string" }, "EN_US": { "type": "string" }, "FR_FR": { "type": "string" }, "ES_ES": { "type": "string" }, "PT_PT": { "type": "string" }, "ZH_CN": { "type": "string" }, "UK_UA": { "type": "string" }, "AR_EG": { "type": "string" }, "RU_RU": { "type": "string" }, "FA_IR": { "type": "string" }, "NL_NL": { "type": "string" } }, "additionalProperties": false, "description": "Organization name." }, "description": { "$schema": "http://json-schema.org/draft-04/schema", "type": "object", "properties": { "DE_DE": { "type": "string" }, "EN_US": { "type": "string" }, "FR_FR": { "type": "string" }, "ES_ES": { "type": "string" }, "PT_PT": { "type": "string" }, "ZH_CN": { "type": "string" }, "UK_UA": { "type": "string" }, "AR_EG": { "type": "string" }, "RU_RU": { "type": "string" }, "FA_IR": { "type": "string" }, "NL_NL": { "type": "string" } }, "additionalProperties": false, "description": "Organization description." }, "descriptionHtml": { "$schema": "http://json-schema.org/draft-04/schema", "type": [ "object", "null" ], "properties": { "DE_DE": { "type": "string" }, "EN_US": { "type": "string" }, "FR_FR": { "type": "string" }, "ES_ES": { "type": "string" }, "PT_PT": { "type": "string" }, "ZH_CN": { "type": "string" }, "UK_UA": { "type": "string" }, "AR_EG": { "type": "string" }, "RU_RU": { "type": "string" }, "FA_IR": { "type": "string" }, "NL_NL": { "type": "string" } }, "additionalProperties": false, "description": "HTML description." }, "text": { "$schema": "http://json-schema.org/draft-04/schema", "type": "object", "properties": { "DE_DE": { "type": "string" }, "EN_US": { "type": "string" }, "FR_FR": { "type": "string" }, "ES_ES": { "type": "string" }, "PT_PT": { "type": "string" }, "ZH_CN": { "type": "string" }, "UK_UA": { "type": "string" }, "AR_EG": { "type": "string" }, "RU_RU": { "type": "string" }, "FA_IR": { "type": "string" }, "NL_NL": { "type": "string" } }, "additionalProperties": false, "description": "Additional text." }, "textHtml": { "$schema": "http://json-schema.org/draft-04/schema", "type": [ "object", "null" ], "properties": { "DE_DE": { "type": "string" }, "EN_US": { "type": "string" }, "FR_FR": { "type": "string" }, "ES_ES": { "type": "string" }, "PT_PT": { "type": "string" }, "ZH_CN": { "type": "string" }, "UK_UA": { "type": "string" }, "AR_EG": { "type": "string" }, "RU_RU": { "type": "string" }, "FA_IR": { "type": "string" }, "NL_NL": { "type": "string" } }, "additionalProperties": false, "description": "HTML text." }, "occurs": { "type": [ "object", "array", "null" ], "description": "Event date ranges." }, "openingHours": { "$schema": "http://json-schema.org/draft-04/schema", "type": "object", "properties": { "DE_DE": { "type": "string" }, "EN_US": { "type": "string" }, "FR_FR": { "type": "string" }, "ES_ES": { "type": "string" }, "PT_PT": { "type": "string" }, "ZH_CN": { "type": "string" }, "UK_UA": { "type": "string" }, "AR_EG": { "type": "string" }, "RU_RU": { "type": "string" }, "FA_IR": { "type": "string" }, "NL_NL": { "type": "string" } }, "additionalProperties": false, "description": "Opening hours." }, "location": { "$schema": "http://json-schema.org/draft-04/schema", "type": "object", "properties": { "DE_DE": { "type": "string" }, "EN_US": { "type": "string" }, "FR_FR": { "type": "string" }, "ES_ES": { "type": "string" }, "PT_PT": { "type": "string" }, "ZH_CN": { "type": "string" }, "UK_UA": { "type": "string" }, "AR_EG": { "type": "string" }, "RU_RU": { "type": "string" }, "FA_IR": { "type": "string" }, "NL_NL": { "type": "string" } }, "additionalProperties": false, "description": "Event location." }, "building": { "$schema": "http://json-schema.org/draft-04/schema", "type": "object", "properties": { "DE_DE": { "type": "string" }, "EN_US": { "type": "string" }, "FR_FR": { "type": "string" }, "ES_ES": { "type": "string" }, "PT_PT": { "type": "string" }, "ZH_CN": { "type": "string" }, "UK_UA": { "type": "string" }, "AR_EG": { "type": "string" }, "RU_RU": { "type": "string" }, "FA_IR": { "type": "string" }, "NL_NL": { "type": "string" } }, "additionalProperties": false, "description": "Building name." }, "city": { "$schema": "http://json-schema.org/draft-04/schema", "type": "object", "properties": { "DE_DE": { "type": "string" }, "EN_US": { "type": "string" }, "FR_FR": { "type": "string" }, "ES_ES": { "type": "string" }, "PT_PT": { "type": "string" }, "ZH_CN": { "type": "string" }, "UK_UA": { "type": "string" }, "AR_EG": { "type": "string" }, "RU_RU": { "type": "string" }, "FA_IR": { "type": "string" }, "NL_NL": { "type": "string" } }, "additionalProperties": false, "description": "City." }, "country": { "type": [ "string", "null" ], "description": "ISO country code." }, "url": { "$schema": "http://json-schema.org/draft-04/schema", "type": "object", "properties": { "DE_DE": { "type": "string" }, "EN_US": { "type": "string" }, "FR_FR": { "type": "string" }, "ES_ES": { "type": "string" }, "PT_PT": { "type": "string" }, "ZH_CN": { "type": "string" }, "UK_UA": { "type": "string" }, "AR_EG": { "type": "string" }, "RU_RU": { "type": "string" }, "FA_IR": { "type": "string" }, "NL_NL": { "type": "string" } }, "additionalProperties": false, "description": "Website URL." }, "ticketingUrl": { "$schema": "http://json-schema.org/draft-04/schema", "type": "object", "properties": { "DE_DE": { "type": "string" }, "EN_US": { "type": "string" }, "FR_FR": { "type": "string" }, "ES_ES": { "type": "string" }, "PT_PT": { "type": "string" }, "ZH_CN": { "type": "string" }, "UK_UA": { "type": "string" }, "AR_EG": { "type": "string" }, "RU_RU": { "type": "string" }, "FA_IR": { "type": "string" }, "NL_NL": { "type": "string" } }, "additionalProperties": false, "description": "Ticketing URL." }, "photo": { "type": [ "string", "null" ], "description": "Organization photo URL." }, "logo": { "type": [ "string", "null" ], "description": "Organization logo URL." }, "background": { "type": [ "string", "null" ], "description": "Background image URL." }, "splashscreen": { "type": [ "string", "null" ], "description": "Splash screen URL." }, "banner": { "type": [ "string", "null" ], "description": "Banner URL." }, "teaser": { "type": [ "string", "null" ], "description": "Teaser URL." }, "mtime": { "type": "integer", "description": "Last modification time (milliseconds since epoch)." }, "agencyTags": { "type": "array", "items": { "type": "string" }, "description": "Agency classification tags." }, "locationTags": { "type": "array", "items": { "type": "string" }, "description": "Location tags." }, "isHighlightEnabled": { "type": "boolean", "description": "Whether highlights are enabled." }, "formatLabels": { "type": [ "object", "null" ], "description": "Lecture format labels." }, "topicLabels": { "type": [ "object", "null" ], "description": "Topic labels." }, "categoryLabels": { "type": [ "object", "null" ], "description": "Category labels." }, "tagLabels": { "type": [ "object", "null" ], "description": "Tag labels." }, "timezone": { "type": "string", "description": "Timezone identifier." }, "locales": { "type": "array", "items": { "type": "string" }, "description": "Supported locales." }, "gallery": { "type": [ "object", "null" ], "description": "Photo gallery." }, "customFields": { "type": [ "object", "null" ], "description": "Custom field definitions." }, "places": { "type": "array", "items": { "type": "string" }, "description": "Associated place IDs." }, "extId": { "type": [ "string", "null" ], "description": "External identifier." } }, "required": [ "orgId", "name", "mtime", "agencyTags", "locationTags", "isHighlightEnabled", "formatLabels", "topicLabels", "categoryLabels", "tagLabels", "timezone", "locales", "gallery", "customFields", "places" ] }, "description": "List of organizations for the agency." }, "agencyTagLabels": { "type": "object", "description": "Human-readable labels for agency tags." }, "locationTagLabels": { "type": "object", "description": "Human-readable labels for location tags." }, "cursor": { "type": [ "string", "null" ], "description": "Pagination cursor for the next page." }, "more": { "type": "boolean", "description": "Whether there are more organizations available." } }, "required": [ "organizations", "more" ] } } } }, "400": { "description": "Bad request (e.g., missing or invalid fields)" }, "403": { "description": "Forbidden" }, "404": { "description": "Agency not found" } } } } }, "openapi": "3.0.3" }