Get an organization

GET

/api/orgs/{org}

const url = 'https://api-dev.wrktr.com/api/orgs/example';
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-dev.wrktr.com/api/orgs/example \
  --header 'Authorization: Bearer <token>'

Its slug and name, whether it’s someone’s personal one, and your role in it.

Authorizations

bearer

Parameters

Path Parameters

org

required

string

Responses

200

OrgInfo

application/json

object

slug

required

string

name

required

string

personal

required

boolean

role

required

string

Allowed values: owner member

Example

{
  "role": "owner"
}

401

Unauthorized

application/json

object

_tag

required

string

Allowed values: Unauthorized

message

required

string

Example

{
  "_tag": "Unauthorized"
}

404

OrgNotFound

application/json

object

_tag

required

string

Allowed values: OrgNotFound

org

required

string

Example

{
  "_tag": "OrgNotFound"
}