Organizations ~ SHIP

List the calling user's orgs

Response Body

`application/json`

curl -X GET "https://example.com/organizations"

{  "orgs": [    {      "id": "string",      "name": "string",      "slug": "string",      "createdByUserId": "string",      "createdAt": 0,      "namePending": true    }  ]}

Create an org (cookieAuth, makes caller owner)

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Length1 <= length <= 120

slug?string

Match^[a-z0-9-]+$

Length1 <= length <= 64

Response Body

`application/json`

curl -X POST "https://example.com/organizations" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'

{  "id": "string",  "name": "string",  "slug": "string",  "createdByUserId": "string",  "createdAt": 0,  "namePending": true}

Fetch an org (membership required)

Path Parameters

orgId*string

Length1 <= length

Response Body

`application/json`

curl -X GET "https://example.com/organizations/string"

{  "id": "string",  "name": "string",  "slug": "string",  "createdByUserId": "string",  "createdAt": 0,  "namePending": true}

Rename an org (cookieAuth, owner/admin only)

Path Parameters

orgId*string

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

Length1 <= length <= 120

slug?string

Match^[a-z0-9-]+$

Length1 <= length <= 64

Response Body

`application/json`

curl -X PATCH "https://example.com/organizations/string" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "string",  "name": "string",  "slug": "string",  "createdByUserId": "string",  "createdAt": 0,  "namePending": true}

Preview the slug the API would derive from an org name (onboarding helper)

Query Parameters

name*string

Length1 <= length <= 120

Response Body

`application/json`

curl -X GET "https://example.com/organizations/slug-preview?name=string"

{  "slug": "string"}

List memberships in an org

Path Parameters

orgId*string

Length1 <= length

Response Body

`application/json`

curl -X GET "https://example.com/organizations/string/memberships"

{  "memberships": [    {      "orgId": "string",      "userId": "string",      "role": "string",      "createdAt": 0    }  ]}

Add a member to an org (owner|admin)

Path Parameters

orgId*string

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

userId*string

Length1 <= length

role*string

Value in

"owner"
"admin"
"member"

Response Body

`application/json`

curl -X POST "https://example.com/organizations/string/memberships" \  -H "Content-Type: application/json" \  -d '{    "userId": "string",    "role": "string"  }'

{  "orgId": "string",  "userId": "string",  "role": "string",  "createdAt": 0}

Close the workspace: archived, and each paid pack's unused credits refunded, withdrawn or forfeited

Path Parameters

orgId*string

Length1 <= length

Response Body

`application/json`

curl -X POST "https://example.com/organizations/string/close"

{  "orgId": "string",  "closedAt": 0,  "basis": "owner",  "settlements": [    {      "orderId": "string",      "packCredits": 1,      "outcome": "withdrawn",      "credits": 0,      "refundUsd": 0,      "refundStatus": "pending"    }  ]}

Organizations

200application/json

401application/json

200application/json

401application/json

409application/json

200application/json

404application/json

200application/json

401application/json

403application/json

404application/json

409application/json

200application/json

401application/json

200application/json

404application/json

200application/json

403application/json

404application/json

200application/json

403application/json

404application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`