Retrieve an instance

get /api/organizations/{organizationId}/instances/{instanceId}

Get an instance.

Returns a single instance of an organization by id, including its name, handle and ownership metadata.

Path parameters

Name	Type	Required	Description
organizationId	string	required	OrganizationInstancesResource identifier
instanceId	string	required	OrganizationInstancesResource identifier

Response

200 - OrganizationInstancesResource resource

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

404 - Not found

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