latestOpenAPI 3.1.02026-08-10150311431.9 KB

c1f3c6d96b31

Orgs

Get an Org

Retrieve a org by name

get/orgs/{name}

Path parameters

namestring required

Response

Retrieved

account_namestring

The unique name of the org in small case without spaces

namestring

The display name for this org

picture_urlstring

URL to the picture associated with this org

contact_emailstring

The contact email for the Organization

descriptionstring

A description of the org

idstring required

The org ID

role'owner' | 'member'

An enumeration.

member_countinteger

The number of members that are part of this org

team_countinteger

The number of teams that are part of this org

Example response

{
  "account_name": "ladybug-tools",
  "name": "Ladybug Tools",
  "picture_url": "https://avatars1.githubusercontent.com/u/38131342",
  "contact_email": "info@ladybug.tools",
  "description": "Making environmental design knowledge and tools freely accessible to every person, project and design process",
  "id": "1eb8e60d-771d-4a30-8078-fe553eb2f0bc",
  "owner": {
    "id": "0ad77f99-8043-46e4-8220-7221487c3ee5",
    "account_type": "user",
    "name": "ladybugbot",
    "display_name": "Ladybug Bot",
    "description": "Beep Boop!"
  },
  "member_count": 10,
  "team_count": 3
}