Orishare
API reference

Find organizations by name, slug, id or member email (staff)

GET
/support/organizations

Authorization

staff
AuthorizationBearer <token>

Audited staff access with a staff grant and audit reason.

In: header

Query Parameters

limit?integer
Range1 <= value <= 200
Default50
cursor?string
Lengthlength <= 2048
q*string
Length2 <= length <= 120

Header Parameters

X-Orishare-Audit-Reason*string

Required for staff authorization. Records the reason for staff access.

Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/support/organizations?q=string" \  -H "X-Orishare-Audit-Reason: string"
{  "data": [    {      "id": "string",      "name": "string",      "slug": "string",      "is_internal": true,      "plan": {        "id": "string",        "version": 0      },      "ai_drafting_disabled": true,      "members": 0,      "projects": [        {          "id": "string",          "name": "string",          "environments": [            {              "id": "string",              "name": "string",              "runtime_class": "string",              "rules_paused": true            }          ]        }      ],      "created_at": "2019-08-24T14:15:22Z"    }  ],  "next_cursor": "string",  "has_more": true}

Organization overview with projects and environments (staff)

GET
/support/organizations/{id}

Authorization

staff
AuthorizationBearer <token>

Audited staff access with a staff grant and audit reason.

In: header

Path Parameters

id*string
Length1 <= length

Header Parameters

X-Orishare-Audit-Reason*string

Required for staff authorization. Records the reason for staff access.

Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/support/organizations/string" \  -H "X-Orishare-Audit-Reason: string"
{  "id": "string",  "name": "string",  "slug": "string",  "is_internal": true,  "plan": {    "id": "string",    "version": 0  },  "ai_drafting_disabled": true,  "members": 0,  "projects": [    {      "id": "string",      "name": "string",      "environments": [        {          "id": "string",          "name": "string",          "runtime_class": "string",          "rules_paused": true        }      ]    }  ],  "created_at": "2019-08-24T14:15:22Z"}

Streaks

Pinned streak programs, periods and freeze inventory.

Teams

Teams of players, their members, team quests and team boards.