Skip to main content
GET
/
organisations
/
{organisation_id}
Get an organisation
curl --request GET \
  --url http://localhost:3001/portal-api/organisations/{organisation_id} \
  --header 'Authorization: <api-key>'
{
  "CreatedAt": "2023-06-23 21:02",
  "UpdatedAt": "2023-06-23 21:02",
  "ID": 1,
  "Name": "Default Organisation",
  "Teams": [
    {
      "Default": true,
      "ID": 1,
      "Name": "Default Organisation All users"
    }
  ],
  "Users": [
    {
      "Active": true,
      "Email": "admin@acme.com",
      "First": "John",
      "Last": "Doe",
      "OrganisationID": 1,
      "Role": "consumer-team-member",
      "Provider": "password",
      "ID": 1
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Path Parameters

​
organisation_id
integer
required

UID of an organisation

Example:

2

Response

200 - application/json

OK

​
CreatedAt
string

Date-time when a user is created

Pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}$
Example:

"2023-06-23 21:02"

​
UpdatedAt
string

Date-time when a user is updated the last time

Pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}$
Example:

"2023-06-23 21:02"

​
ID
integer

UID of an organisation

Example:

1

​
Name
string

Name of an organisation

Example:

"Default Organisation"

​
Teams
object[]

Teams included in this organisation

​
Users
object[]

Users that are included in this organisation. For newly created organisation this field will be an empty array