List instances

get /api/organizations/{organizationId}/instances

List instances accessible within an organization.

Returns the paginated collection of instances accessible to the authenticated partner within an organization. Filter by name or handle, and order by any of the listed fields.

Path parameters

Name	Type	Required	Description
organizationId	string	required	OrganizationInstancesResource identifier

Query parameters

Name	Type	Required	Description
name	string	-	Partial case-insensitive search on the instance name. Combined as AND with handle when both are provided.
handle	string	-	Partial case-insensitive search on the instance handle. Combined as AND with name when both are provided.
order[name]	string	-	Sort by name. Values: asc, desc.
order[handle]	string	-	Sort by handle. Values: asc, desc.
order[createdAt]	string	-	Sort by creation date. Values: asc, desc. Default order when no order parameter is provided: createdAt desc.
order[updatedAt]	string	-	Sort by last update date. Values: asc, desc.
page	integer	-	The collection page number
itemsPerPage	integer	-	The number of items per page

Response

200 - OrganizationInstancesResource collection

Property	Type	Required	Description
totalItems	integer	-
search	object	-
Show search fields Property Type Required Description @type string - template string - variableRepresentation string - mapping object[] - Show mapping fields Property Type Required Description @type string - variable string - property string | null - required boolean -
view	object	-
Show view fields Property Type Required Description @id string - @type string - first string - last string - previous string - next string -
member	OrganizationInstancesResource[]	required
Show member fields Property Type Required Description @context object - @id string required @type string required id string | null - Unique identifier of the instance. name string | null - Human-readable display name of the instance. handle string | null - Stable, URL-safe identifier of the instance. Used as the tenant subdomain when addressing the per-instance product services (e.g. https://acme-eu.product-management.flowkiwi.net). Lowercase letters and hyphens only, no leading or trailing hyphen, unique across all instances. created_at string | null - Date and time the instance was created (ISO 8601, UTC). updated_at string | null - Date and time the instance was last updated (ISO 8601, UTC). organization_id string | null - Identifier of the organization that currently owns the instance. created_by_organization_id string | null - Identifier of the organization that originally created the instance. Immutable, it does not change when the instance is transferred to another organization.

Errors

403 - Forbidden

Property	Type	Required	Description
@context	object	-
@id	string	required
@type	string	required
title	string | null	-	A short, human-readable summary of the problem.
detail	string | null	-	A human-readable explanation specific to this occurrence of the problem.
status	number | null	-
instance	string | null	-	A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
type	string	-	A URI reference that identifies the problem type