Query parameters

• q string

  The query to filter organizations. It can be a partial ID or name.

  If not provided, all organizations will be returned.

• showFeatured string

  Whether to show featured users in the organization. Featured users are randomly selected from the organization members.

  If not provided, featuredUsers will not be included in the response.

• page integer

  Page number (starts from 1).

  Minimum value is 1. Default value is 1.

• page_size integer

  Entries per page.

  Minimum value is 1. Default value is 20.

Responses

• 200 application/json

  A list of organizations.

  Hide response attributes Show response attributes object

  • tenantId string Required

    Maximum length is 21.

  • id string Required

    Minimum length is 1, maximum length is 21.

  • name string Required

    Minimum length is 1, maximum length is 128.

  • description string | null Required

    Maximum length is 256.

  • customData object Required

    arbitrary

    Additional properties are allowed.

  • isMfaRequired boolean Required
  • branding object Required

    Additional properties are allowed.

    Hide branding attributes Show branding attributes object

    • logoUrl string(url)
    • darkLogoUrl string(url)
    • favicon string(url)
    • darkFavicon string(url)
  • createdAt number Required
  • usersCount number
  • featuredUsers array[object]
    Hide featuredUsers attributes Show featuredUsers attributes object

    • id string Required

      Minimum length is 1, maximum length is 12.

    • avatar string | null Required

      Maximum length is 2048.

    • name string | null Required

      Maximum length is 128.

• 400

  Bad Request

• 401

  Unauthorized

• 403

  Forbidden