Skip to main content

List organizations

Returns a list of organizations. It can be filtered by userID or organization state.

Query Parameters
    user_id string

    The user ID to filter by. It can be used to list all the organizations that the user is a member of. Otherwise, all the organizations in the Frontier instance will be listed.

    state string

    The state to filter by. It can be enabled or disabled.

Responses

A successful response.


Schema
    organizations object[]
  • Array [
  • id string
    name string
    title string
    metadata object
    created_at date-time

    The time the organization was created.

    updated_at date-time

    The time the organization was last updated.

    state string

    The state of the organization (enabled or disabled).

    avatar string

    The base64 encoded image string of the organization avatar. Should be less than 2MB.

  • ]
GET /v1beta1/organizations

Authorization

name: Basic type: httpdescription: use Client ID as username and Client Secret as passwordin: headerscheme: basic

Request

Base URL
http://127.0.0.1:7400
Security Scheme
Username
Password
user_id — query
state — query
curl / cURL
curl -L -X GET 'http://127.0.0.1:7400/v1beta1/organizations' \
-H 'Accept: application/json'