Get a list of organizations
/api/v1/organizations
{basePath}/organizations?offset=1&limit=2
The API returns a list of organizations with which the integrator is privileged to interact.Request
- application/json
-
limit: integer
Minimum Value:
0The limit used for the current page.The maximum number of items to return in this request. -
offset: integer
Minimum Value:
0The offset of the start of the current page in the collection. If offset is not included in the request then all objects returned.
Response
- application/json
200 Response
objecttrue-
count:
integer
Total number of items in the collection for all pages.
-
limit:
integer
The limit used for the current page.
-
offset:
integer
The offset of the start of the current page in the collection.
-
organization(required):
array organization
Array of Organization JSON objects. If there are no organizations configured, this array will be empty.
array-
Array of:
object Organization
Title:
OrganizationAn organization is the overarching organizational entity for a specific customer in Oracle Food and Beverage Cloud Products. An organization includes one or more locations.
objectOrganization-
name(required):
string
Full name of the organization.Example:
The Food Organization Inc -
orgShortName(required):
string
Minimum Length:
1Maximum Length:10Pattern:[A-Za-z0-9]The organization identifier.Example:tfoinc
{
"orgShortName":"tfoinc",
"name":"The Food Organization Inc"
}400 Response
object-
details:
string
A human-readable explanation specific to this occurrence of the problem.
-
instance:
string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
-
title:
string
A short, human-readable summary of the problem type.
-
type:
string
A URI reference [RFC3986](https://tools.ietf.org/html/rfc3986) that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".
{
"type":"error:validation",
"title":"Required value not specified.",
"details":"The OrgShortName value is required.",
"instance":"required_value_missing"
}401 Response
-
WWW-Authenticate: string
Bearer authentication challenge. When token validation fails, the header may include error and error_description parameters.
The following conditions and HTTP response examples are illustrative and not exhaustive. Error descriptions may vary.
No token provided: No access token is provided, or the Authorization request header is missing. The response header is WWW-Authenticate: Bearer, without error or error_description parameters.
Example:
HTTP/1.1 401 Unauthorized WWW-Authenticate: BearerExpired token: The access token has expired. The timestamp in this example is illustrative.
Example:
HTTP/1.1 401 Unauthorized WWW-Authenticate: Bearer error="invalid_token", error_description="The token expired at '05/19/2026 17:16:29'"Signing key not found: The token cannot be validated because its signing key was not found. For example, the token's key ID (kid) does not match a key in the JSON Web Key Set (JWKS) used for validation.
Example:
HTTP/1.1 401 Unauthorized WWW-Authenticate: Bearer error="invalid_token", error_description="The signature key was not found"Invalid signature: The token signature is invalid. For example, the token may have been modified.
Example:
HTTP/1.1 401 Unauthorized WWW-Authenticate: Bearer error="invalid_token", error_description="The signature is invalid"For the missing-token, signing-key-not-found, and invalid-signature examples above, the response body is empty. The authentication error details are provided in the WWW-Authenticate response header.
The response may include an additional WWW-Authenticate header containing a bare Bearer challenge alongside the challenge shown in these examples.
403 Response
404 Response
Examples
Example Request Body
Not applicable for this endpoint.
Example Response Body
The following example shows the contents of the response body in JSON format:
{
"limit": 0,
"offset": 0,
"count": 0,
"items": [
{
"orgShortName": "tfoinc",
"name": "The Food Organization Inc"
}
]
}