Read

Read vendors

POST https://event.talque.com/api/v1/vendors/read

This endpoint allows you to read multiple vendor records in a single request. It takes a list of vendor identifiers and an organization identifier as parameter and returns the vendor objects for the given vendor ID list. You can find a basic example at https://github.com/talque/webhook-samples/blob/main/src/vendor/read.py

Request Body

Name
Type
Description

orgId*

string

Organization identifier

vendorIdList*

string[]

List of vendor identifiers

extIdList

string[]

List of external identifiers for vendors

{
    "reason": "SUCCESS",
    "reasonEnum": "VendorReadReason",
    "success": true,
    "vendorById": {
        "ZaZOqly9jKfdzHVYZdOw": {
            {
                "address": null,
                "backgroundImage": "https://path/to/image.png",
                "booth": null,
                "country": null,
                "ctime": 1587067562992,
                "customData": {
                    "data": []
                },
                "description": {
                    "EN_US": "*bold* description"
                },
                "descriptionHtml": {
                    "EN_US": "<div>\n<p><b>bold</b> description</p>\n</div>"
                },
                "email": "vendor@example.com",
                "exhibitor": null,
                "extId": null,
                "facebook": "",
                "gallery": {
                    "config": {
                        "embed": 0,
                        "image": 20,
                        "limit": 0,
                        "video": 0
                    },
                    "items": []
                },
                "instagram": "",
                "isPublished": true,
                "linkedin": "",
                "locale": "EN_US",
                "main":[],
                "mtime": 1587067562992,
                "name": {
                    "EN_US": "Partner Name"
                },
                "phone": null,
                "photo": "https://path/to/photo.png",
                "photoMedium": "https://path/to/photo-medium.png",
                "portfolio": {
                    "config": {
                        "document": 0,
                        "limit": 0
                    },
                    "items": []
                },
                "sponsor": "partner",
                "subjects": [],
                "twitter": "https://twitter.com/example",
                "vendorId": "ZaZOqly9jKfdzHVYZdOw",
                "website": "vendor.example.com",
                "xing": ""
            }
        },
    },
    "byExtId": {}
}

Example Request

Example Response

PreviousListNextAuthorization

Last updated

Was this helpful?