Skip to main content
GET
/
v1
/
organizations
Get Organizations By User
curl --request GET \
  --url https://api.trykintsugi.com/v1/organizations \
  --header 'X-API-KEY: <api-key>'
{
  "items": [
    {
      "name": "<string>",
      "external_id": "<string>",
      "promo": "<string>",
      "id": "<string>",
      "status": "ACTIVE",
      "is_test": true,
      "billing_plan": "FREE",
      "disable_emails": false,
      "customer_id": "<string>",
      "subscription_id": "<string>",
      "scheduled_deletion": "2023-12-25",
      "email_group": "<string>",
      "internal_use": false,
      "archival_reason": "<string>",
      "archival_reason_notes": "<string>",
      "archival_by": "<string>",
      "archival_at": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 1,
  "page": 2,
  "size": 2,
  "pages": 1
}

Authorizations

​
X-API-KEY
string
header
required

Query Parameters

​
selected_organization_id
string | null
​
query
string | null
​
page
integer
default:1

Page number

Required range: x >= 1
​
size
integer
default:50

Page size

Required range: 1 <= x <= 100

Response

Successful Response

​
items
OrganizationRead · object[]
required
​
total
integer
required
Required range: x >= 0
​
page
integer
required
Required range: x >= 1
​
size
integer
required
Required range: x >= 1
​
pages
integer
required
Required range: x >= 0