Skip to main content
GET
Get business collection

Authorizations

Authorization
string
header
required

Polymorfa organization key (pmfa_ prefix), project token (pmfa_pt_ prefix) where supported, or short-lived client token (pmfa_ct_ prefix). Organization and project keys may be personal or service-account owned and enforce selected action scopes. Organization keys cover the team and its projects; project tokens stay inside one project. Client tokens stay inside their live project and session and enforce their client rules.

Path Parameters

session
string
required

Identifier of the connected Polymorfa session.

collectionId
string
required

Identifier for the collection.

Value constraints

Maximum string length: 256

Query Parameters

id
string
required

Identifier for this resource.

Value constraints

Maximum string length: 256
Pattern: ^pmfa_lid_[1-9]\d*$
after
string

Specifies after for this query parameter.

Value constraints

Maximum string length: 2048
limit
integer

Specifies limit for this query parameter.

Value constraints

Required range: 1 <= x <= 100
width
integer

Width in pixels.

Value constraints

Required range: 1 <= x <= 1024
height
integer

Height in pixels.

Value constraints

Required range: 1 <= x <= 1024

Response

Live collection

success
enum<boolean>
required

Whether the request succeeded.

Allowed values

Available options:
true
data
object
required

Structured data carried by this object.