/v1/orgs/{id}

GET

/v1/orgs/{id}

const url = 'https://api.reindeer.example.tr/v1/orgs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.reindeer.example.tr/v1/orgs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Scope orgs:read. The organisation with its append-only history in events. Recorded in the audit log.

Authorizations

mutualTLS
session

Parameters

Path Parameters

required

string format: uuid

Responses

200

Organisation

application/json

object

string

name

string

state

string

Allowed values: pending active suspended

contact_email

string

data_source

string

terms_version

string

founder

string

founder_name

string

source

Staff views only: the network the signup came from, an IPv4 /24 or an IPv6 /48

string

created_at

string format: date-time

activated_at

string format: date-time

suspended_at

string format: date-time

events

Array<object>

object

string format: date-time

kind

string

Allowed values: signed_up activated suspended resumed

string

approval

string

reason

string

Example

{
  "state": "pending",
  "events": [
    {
      "kind": "signed_up"
    }
  ]
}