OFofficernd
Organizations

Get the current organization information

Get the current organization information

Required scopes: flex.settings.organization.read

get/api/v2/organizations/{orgSlug}

Request

  • Base URL
    https://app.officernd.com
  • URL
    https://app.officernd.com/api/v2/organizations/{orgSlug}
  • Auth
    OAuth 2
    Authorization code: https://identity.officernd.com/auth/authorize
    Client credentials
    Token URL: https://identity.officernd.com/auth/token scopes: flex.settings.organization.read

Path parameters

orgSlugstring required

organization slug

Response

_idstring

The _id of the organization.

namestring

The name of the organization.

slugstring

The slug of the organization.

imageUrlstring

The image URL of the organization.

descriptionstring

The description of the organization.

regionstring

The region of the organization. Read-only.

Example response

{
  "_id": "6080186f490fcf6e0547ec50",
  "name": "Organization Name",
  "slug": "organization-slug",
  "imageUrl": "/image-url.com",
  "description": "Organization Description",
  "region": "Ireland"
}

Changes

No recorded changes to this operation across all 1 revision of this API.