Get Org

GET 
/v1/org/:org_identifier

Get an organization by ID or short name, requires org:config:view or org:config:edit permissions on the organization

Request

Path Parameters

org_identifier anyrequired

Organization ID or short name

Responses

200

Successful Response

application/json

Schema

Schema

org_id uuidrequired
name Name (string)

Official Full Name

primary_contact_email Primary Contact Email (string)

Email Address for the primary point of contact

short_name Short Name (string)required

Possible values: non-empty

Name used in URLs

last_modified_timestamp date-timerequired
created_timestamp date-timerequired
archive Archive (boolean)required

Example (from schema)

{
  "org_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "primary_contact_email": "string",
  "short_name": "string",
  "last_modified_timestamp": "2024-07-29T15:51:28.071Z",
  "created_timestamp": "2024-07-29T15:51:28.071Z",
  "archive": true
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...