--- updatedAt: 2026-06-05T20:14:09.000Z --- # List Business Content Images List content images associated with the business. # OpenAPI definition ```json { "openapi": "3.0.2", "info": { "version": "1.0", "title": "Branded Communications Exchange", "termsOfService": "https://firstorion.com/terms-use/", "x-logo": { "url": "https://firstorion.com/wp-content/themes/salient-child/img/logo-icon-blue.svg", "backgroundColor": "rgba(0,0,0,0)", "altText": "First Orion Logo" }, "description": "> Please avoid using APIs that are marked `deprecated`. While the functions / endpoints will work for the time being, they will be deprecated in the next major release of the APIs.\n", "license": { "url": "change this and name", "name": "Apache 2.0" } }, "servers": [ { "url": "https://api.firstorion.com", "description": "Production Environment" }, { "url": "https://api.forp-lab.com", "description": "Integration Environment" } ], "components": { "schemas": { "businessId": { "type": "string", "description": "System generated unique identifier for the business", "example": "719d140e-fd6c-4d59-9241-3dee71b38320" }, "imageId": { "type": "string", "readOnly": true, "description": "System generated unique identifier of a logo image", "example": "a813e38c-8730-4ce4-80b1-0bead1186e4d" }, "Image-status": { "type": "string", "readOnly": true, "description": "Status of the image. Only APPROVED images can be used to brand calls.", "enum": [ "APPROVED", "PENDING", "REJECTED" ], "example": "PENDING" }, "name": { "type": "string", "minimum": 1, "maximum": 32, "description": "User defined name for the image", "example": "Official Company Logo" }, "originalImageUrl": { "type": "string", "readOnly": true, "description": "Link to the original SVG file that was uploaded.", "maximum": 256, "example": "https://domain/a813e38c-8730-4ce4-80b1-0bead1186e4d.svg" }, "renderedImage": { "type": "object", "properties": { "format": { "type": "string", "description": "Format of the image", "example": "png" }, "height": { "type": "integer", "description": "Height of the image in pixels", "example": 256 }, "width": { "type": "integer", "description": "Width of the image in pixels", "example": 256 }, "sha256": { "type": "string", "description": "Sha-256 hash of the image", "example": "sha256-CMrT0QA09EbAVrEms8MiFkvkauiAM3PB3rkofhUeQTc=" }, "url": { "type": "string", "readOnly": true, "description": "Link to the image in a CDN location", "maximum": 256, "example": "https://domain/path/image.png" }, "status": { "$ref": "#/components/schemas/Image-status" }, "jcard": { "type": "object", "readOnly": true, "properties": { "content": { "type": "string", "description": "Base64 encoded jcard object", "example": "WyJ2Y2FyZCIsW1sidmVyc2lvbiIse30sInRleHQiLCI0LjAiXSxbInN1YmplY3QiLHt9LCJ0ZXh0IiwiaWRrIHdoYXQgdG8gcHV0IGhlcmUiXSxbImxvZ28iLHt9LCJ1cmkiLCJodHRwczovL3MzLnVzLWVhc3QtMS5hbWF6b25hd3MuY29tL2V4Y2hhbmdlLWltYWdlcy91cGxvYWRzLzgxMDJmZWVmLTA1NWItNDg2NS1hZWJiLWEyZmEzOTAxOGU1My5wbmciXV1d" }, "sha256": { "type": "string", "description": "Sha-256 hash of the jcard object", "example": "sha256-CMrT0QA09EbAVrEms8MiFkvkauiAM3PB3rkofhUeQTc=" }, "url": { "type": "string", "description": "URL to the jcard file in a CDN location", "maximum": 256, "example": "https://domain/path/8102feef-055b-4865-aebb-a2fa39018e53.json" } } } } }, "Existing-Approved-Image-Response-Body": { "type": "object", "properties": { "contentId": { "$ref": "#/components/schemas/imageId" }, "resellerId": { "type": "string", "example": "186e4d8c-8730-3dee-80b1-4d59d11880b1" }, "businessId": { "type": "string", "example": "719d140e-fd6c-4d59-9241-3dee71b38320" }, "type": { "type": "string", "example": "IMAGE" }, "status": { "$ref": "#/components/schemas/Image-status", "example": "APPROVED" }, "lastUpdated": { "type": "string", "example": "1702249909" }, "lastUpdatedBy": { "type": "string", "example": "VETTING_ORCHESTRATOR" }, "note": { "type": "string", "example": "Your image note" }, "name": { "$ref": "#/components/schemas/name" }, "originalImageUrl": { "$ref": "#/components/schemas/originalImageUrl" }, "renderedImages": { "type": "array", "items": { "$ref": "#/components/schemas/renderedImage" } } } } }, "responses": { "Unauthorized": { "description": "Unauthorized" }, "Forbidden": { "description": "Forbidden" }, "BusinessResourceNotFound": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "description": "Response", "properties": { "body": { "type": "object", "nullable": true, "example": null }, "error": { "type": "object", "properties": { "code": { "type": "string", "description": "Error code", "example": 404 }, "message": { "type": "string", "description": "Description of the error", "example": "rpc error: code = NotFound desc = business not found" } } } } } } } }, "BusinessBadRequest": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "description": "Response", "properties": { "body": { "type": "object", "nullable": true, "example": null }, "error": { "type": "object", "properties": { "code": { "type": "string", "description": "Error code", "example": 400 }, "message": { "type": "string", "description": "Description of the error", "example": "path validation failed for field businessId: value is required" } } } } } } } } } }, "x-tagGroups": [ { "name": "Authentication", "tags": [ "Authentication", "OAuth2.0" ] }, { "name": "Businesses", "tags": [ "Businesses", "Business Addresses", "Business Contacts", "Business Images", "Business API Keys", "Business Units" ] }, { "name": "Phone Numbers", "tags": [ "Business Phone Numbers", "Business Unit Phone Numbers", "CallerName aNumbers" ] }, { "name": "Programs", "tags": [ "Programs", "Schedules" ] }, { "name": "Program Delivery Channels", "tags": [ "Delivery Channels", "CallerName", "CallerImage", "Blocking", "Engage SDK" ] }, { "name": "Call Authentication", "tags": [ "Call Authentication", "Call Authentication V2", "PreCall Engage SDK" ] }, { "name": "Reference Data", "tags": [ "Employee Count Ranges", "Daily Call Count Ranges", "Industries", "Call Purposes" ] }, { "name": "Utilities", "tags": [ "Phone Number Verification" ] } ], "paths": { "/exchange/v1/businesses/{businessId}/content/images": { "summary": "Business Images", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string", "example": "" } }, { "name": "businessId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/businessId" } } ], "get": { "summary": "List Business Content Images", "description": "List content images associated with the business.", "operationId": "GetBusinessContentImages", "tags": [ "Business Content Images" ], "parameters": [ { "in": "query", "name": "limit", "schema": { "type": "integer", "minimum": 1, "maximum": 1024, "default": 20, "example": 500 }, "description": "How many items are included in the response" }, { "in": "query", "name": "pageHash", "schema": { "type": "string", "example": "systemProvidedHashString" }, "description": "Page identifier" }, { "name": "name", "in": "query", "description": "Filter down images by matching the name to the provided value. Provided string should be url encoded and it is case sensitive. Matching is done using \"starts with\" function.", "schema": { "type": "string", "example": "Good" } }, { "name": "status", "in": "query", "description": "Filter down images by status. Provided string should be url encoded and it is case sensitive. Matching is done using \"exact match\" function.", "schema": { "type": "string", "example": "PENDING", "enum": [ "PENDING", "REJECTED", "APPROVED" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "body": { "type": "array", "items": { "$ref": "#/components/schemas/Existing-Approved-Image-Response-Body" } }, "info": { "type": "object", "properties": { "count": { "type": "integer", "example": 1 }, "limit": { "type": "integer", "example": 500 }, "nextPage": { "type": "string", "example": "" } } }, "error": { "type": "string", "example": null } } } } } }, "400": { "$ref": "#/components/responses/BusinessBadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/BusinessResourceNotFound" } } } } }, "x-readme": { "explorer-enabled": false } } ```