Get images

Get the active images uploaded for a company, filtered by type. For type=campaign the result is a paginated collection (with pagination meta); for type=partners it returns a flat (non-paginated) array, so per_page only applies to campaign. Each image's path resolves to a full S3 URL.

Auth: Both — authentication. Target company must sit inside your own account tree, keyed on company_id: the value must resolve into the authenticated user's company hierarchy. A Partner can reach any company in its tree; an Account reaches only companies in its own hierarchy.

Rate limit: No rate limit.

Request

  • Query: company_id (integer, required) — must be an existing account and belong to the auth company hierarchy.
  • Query: type (string, required) — one of partners, campaign.
  • Query: per_page (integer, optional) — defaults to 10; only honored when type=campaign (the paginated branch).

Response{ data. } envelope.

  • For type=partners, data.data is an array of image objects:
  • id (integer) — image id.
  • name (string) — sanitized file name.
  • type (string) — image type (partners).
  • status (string) — active.
  • path (string|null) — full S3 URL, or null when no stored path.
  • For type=campaign, data.data is a paginated collection where each item has the same id/name/type/status/path shape, plus standard links/meta pagination keys.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

Required. Company that owns the images and must belong to the auth company.

string
required

Required. One of partners | campaign. Campaign returns a paginated collection.

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json