> For the complete documentation index, see [llms.txt](https://talque.gitbook.io/public/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://talque.gitbook.io/public/json-api/vendors/talque-vendor-api.md).

# Talque Vendor API

## Read vendors by ID

> Looks up vendors by IDs or external IDs.

```json
{"openapi":"3.0.3","info":{"title":"Talque Vendor API","version":"1.0.0"},"paths":{"/api/v1/vendor/read":{"post":{"summary":"Read vendors by ID","description":"Looks up vendors by IDs or external 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":{"orgId":{"type":"string","description":"The unique identifier of the organization."},"vendorIdList":{"type":"array","items":{"type":"string"},"description":"List of vendor IDs to look up."},"extIdList":{"type":"array","items":{"type":"string"},"description":"List of external IDs to look up."}},"required":["orgId","vendorIdList"]}}}},"responses":{"200":{"description":"Lookup completed (individual vendors may still be not found)","content":{"application/json":{"schema":{"type":"object","properties":{"orgId":{"type":"string","description":"The unique identifier of the organization."},"vendorById":{"type":"object","additionalProperties":{"type":"object","properties":{"success":{"type":"boolean","description":"Whether the vendor was found."},"reason":{"type":"string","description":"Machine-readable result code."},"model":{"type":["object","null"],"properties":{"vendorId":{"type":"string","description":"The unique identifier of the vendor."},"ctime":{"type":"integer","description":"Creation time of the vendor (milliseconds since epoch)."},"mtime":{"type":"integer","description":"Last modification time of the vendor (milliseconds since epoch)."},"editMtime":{"type":"integer","description":"Last edit time of the vendor (milliseconds since epoch)."},"isPublished":{"type":"boolean","description":"Whether the vendor is visible to the public."},"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":"Public vendor name."},"adminName":{"$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":"Internal admin name of the vendor."},"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":"Vendor description."},"descriptionHtml":{"$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":"HTML-rendered vendor description."},"locale":{"type":"string","description":"Primary locale of the vendor."},"exhibitor":{"type":["string","null"],"description":"Exhibitor category."},"sponsor":{"type":["string","null"],"description":"Sponsor category."},"subjects":{"type":"array","items":{"type":"string"},"description":"Subject tags."},"photo":{"type":["string","null"],"description":"Profile photo URL."},"photoMedium":{"type":["string","null"],"description":"Medium photo URL."},"backgroundImage":{"type":["string","null"],"description":"Background image URL."},"hall":{"type":"string","description":"Hall/location identifier."},"booth":{"type":"string","description":"Booth number/identifier."},"address":{"type":"string","description":"Street address."},"zipCode":{"type":"string","description":"Postal code."},"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 name."},"country":{"type":["string","null"],"description":"ISO country code."},"email":{"type":["string","null"],"description":"Contact email."},"phone":{"type":["string","null"],"description":"Contact phone."},"social":{"type":["object","array"],"description":"Social media links."},"customData":{"type":"object","description":"Custom field data."},"gallery":{"type":"object","description":"Photo gallery."},"portfolio":{"type":"object","description":"Portfolio items."},"extId":{"type":["string","null"],"description":"External identifier."},"perks":{"type":"array","items":{"type":"string"},"description":"Perk IDs."},"marks":{"type":"array","items":{"type":"string"},"description":"Product marks/labels."},"subMarks":{"type":"array","description":"Sub-marks."},"crafts":{"type":"array","description":"Craft/skill tags."},"main":{"type":"array","items":{"type":"string"},"description":"Parent vendor IDs."},"buttons":{"type":"array","items":{"type":"object"},"description":"Action buttons."}},"required":["vendorId","ctime","mtime","editMtime","isPublished","name","adminName","description","descriptionHtml","locale","subjects","hall","booth","address","zipCode","city","social","customData","gallery","portfolio","perks","marks","subMarks","crafts","main","buttons"],"description":"The vendor data, or null if not found."}},"required":["success","reason","model"]},"description":"Map from vendor ID to its result."},"byExtId":{"type":"object","additionalProperties":{"type":"object","properties":{"success":{"type":"boolean","description":"Whether the vendor was found."},"reason":{"type":"string","description":"Machine-readable result code."},"model":{"type":["object","null"],"properties":{"vendorId":{"type":"string","description":"The unique identifier of the vendor."},"ctime":{"type":"integer","description":"Creation time of the vendor (milliseconds since epoch)."},"mtime":{"type":"integer","description":"Last modification time of the vendor (milliseconds since epoch)."},"editMtime":{"type":"integer","description":"Last edit time of the vendor (milliseconds since epoch)."},"isPublished":{"type":"boolean","description":"Whether the vendor is visible to the public."},"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":"Public vendor name."},"adminName":{"$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":"Internal admin name of the vendor."},"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":"Vendor description."},"descriptionHtml":{"$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":"HTML-rendered vendor description."},"locale":{"type":"string","description":"Primary locale of the vendor."},"exhibitor":{"type":["string","null"],"description":"Exhibitor category."},"sponsor":{"type":["string","null"],"description":"Sponsor category."},"subjects":{"type":"array","items":{"type":"string"},"description":"Subject tags."},"photo":{"type":["string","null"],"description":"Profile photo URL."},"photoMedium":{"type":["string","null"],"description":"Medium photo URL."},"backgroundImage":{"type":["string","null"],"description":"Background image URL."},"hall":{"type":"string","description":"Hall/location identifier."},"booth":{"type":"string","description":"Booth number/identifier."},"address":{"type":"string","description":"Street address."},"zipCode":{"type":"string","description":"Postal code."},"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 name."},"country":{"type":["string","null"],"description":"ISO country code."},"email":{"type":["string","null"],"description":"Contact email."},"phone":{"type":["string","null"],"description":"Contact phone."},"social":{"type":["object","array"],"description":"Social media links."},"customData":{"type":"object","description":"Custom field data."},"gallery":{"type":"object","description":"Photo gallery."},"portfolio":{"type":"object","description":"Portfolio items."},"extId":{"type":["string","null"],"description":"External identifier."},"perks":{"type":"array","items":{"type":"string"},"description":"Perk IDs."},"marks":{"type":"array","items":{"type":"string"},"description":"Product marks/labels."},"subMarks":{"type":"array","description":"Sub-marks."},"crafts":{"type":"array","description":"Craft/skill tags."},"main":{"type":"array","items":{"type":"string"},"description":"Parent vendor IDs."},"buttons":{"type":"array","items":{"type":"object"},"description":"Action buttons."}},"required":["vendorId","ctime","mtime","editMtime","isPublished","name","adminName","description","descriptionHtml","locale","subjects","hall","booth","address","zipCode","city","social","customData","gallery","portfolio","perks","marks","subMarks","crafts","main","buttons"],"description":"The vendor data, or null if not found."}},"required":["success","reason","model"]},"description":"Map from external ID to its result."}},"required":["orgId","vendorById","byExtId"]}}}},"400":{"description":"Bad request (e.g., missing or invalid fields)"},"403":{"description":"Forbidden"},"404":{"description":"Organization not found"}}}}}}
```

## List vendors in an organization

> Returns vendors with optional pagination.

```json
{"openapi":"3.0.3","info":{"title":"Talque Vendor API","version":"1.0.0"},"paths":{"/api/v1/vendor/list":{"post":{"summary":"List vendors in an organization","description":"Returns vendors with optional pagination.","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":{"orgId":{"type":"string","description":"The unique identifier of the organization."},"limit":{"type":"integer","description":"Maximum number of vendors to return."},"cursor":{"type":["string","null"],"description":"Pagination cursor from a previous response."}},"required":["orgId"]}}}},"responses":{"200":{"description":"List of vendors","content":{"application/json":{"schema":{"type":"object","properties":{"orgId":{"type":"string","description":"The unique identifier of the organization."},"vendors":{"type":"array","items":{"type":"object","properties":{"vendorId":{"type":"string","description":"The unique identifier of the vendor."},"ctime":{"type":"integer","description":"Creation time of the vendor (milliseconds since epoch)."},"mtime":{"type":"integer","description":"Last modification time of the vendor (milliseconds since epoch)."},"editMtime":{"type":"integer","description":"Last edit time of the vendor (milliseconds since epoch)."},"isPublished":{"type":"boolean","description":"Whether the vendor is visible to the public."},"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":"Public vendor name."},"adminName":{"$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":"Internal admin name of the vendor."},"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":"Vendor description."},"descriptionHtml":{"$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":"HTML-rendered vendor description."},"locale":{"type":"string","description":"Primary locale of the vendor."},"exhibitor":{"type":["string","null"],"description":"Exhibitor category."},"sponsor":{"type":["string","null"],"description":"Sponsor category."},"subjects":{"type":"array","items":{"type":"string"},"description":"Subject tags."},"photo":{"type":["string","null"],"description":"Profile photo URL."},"photoMedium":{"type":["string","null"],"description":"Medium photo URL."},"backgroundImage":{"type":["string","null"],"description":"Background image URL."},"hall":{"type":"string","description":"Hall/location identifier."},"booth":{"type":"string","description":"Booth number/identifier."},"address":{"type":"string","description":"Street address."},"zipCode":{"type":"string","description":"Postal code."},"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 name."},"country":{"type":["string","null"],"description":"ISO country code."},"email":{"type":["string","null"],"description":"Contact email."},"phone":{"type":["string","null"],"description":"Contact phone."},"social":{"type":["object","array"],"description":"Social media links."},"customData":{"type":"object","description":"Custom field data."},"gallery":{"type":"object","description":"Photo gallery."},"portfolio":{"type":"object","description":"Portfolio items."},"extId":{"type":["string","null"],"description":"External identifier."},"perks":{"type":"array","items":{"type":"string"},"description":"Perk IDs."},"marks":{"type":"array","items":{"type":"string"},"description":"Product marks/labels."},"subMarks":{"type":"array","description":"Sub-marks."},"crafts":{"type":"array","description":"Craft/skill tags."},"main":{"type":"array","items":{"type":"string"},"description":"Parent vendor IDs."},"buttons":{"type":"array","items":{"type":"object"},"description":"Action buttons."}},"required":["vendorId","ctime","mtime","editMtime","isPublished","name","adminName","description","descriptionHtml","locale","subjects","hall","booth","address","zipCode","city","social","customData","gallery","portfolio","perks","marks","subMarks","crafts","main","buttons"]},"description":"Vendors in the organization."},"cursor":{"type":["string","null"],"description":"Pagination cursor for the next page."},"more":{"type":"boolean","description":"Whether there are more vendors to fetch."}},"required":["orgId","vendors","more"]}}}},"400":{"description":"Bad request (e.g., missing or invalid fields)"},"403":{"description":"Forbidden"},"404":{"description":"Organization not found"}}}}}}
```