Retrieve all organizations for the authenticated User

GET 
/v1/organizations/my

Retrieve all organizations for the authenticated User

Request

Query Parameters

page numberrequired
Possible values: >= 1
Default value: 1
Page number starting from 1.
Example: 1
limit numberrequired
Possible values: >= 1 and <= 100
Default value: 10
Limit the number of results returned. Default is 10.
Example: 10

Responses

200

application/json

Schema

Schema

data object[]required
Array of user-organization roles
Array [
organization object
id stringrequired
The unique ID of the organization
name stringrequired
The name of the organization
plan object
The organization's plan
name stringrequired
Possible values: [pro_monthly, pro_yearly, team_monthly, team_yearly]
The name of the organization's plan
status stringrequired
Possible values: [PENDING, ACTIVE, INCOMPLETE, CANCELED]
The status of the organization's plan
role stringrequired
Possible values: [OWNER, ADMIN, MEMBER]
The role of the user within the organization.
]
metadata object

currentPage numberrequired

The current page number.

limit numberrequired

Number of items per page.

total numberrequired

Total number of items.

nextPage numbernullablerequired

The next page number, or null if this is the last page.

previousPage numbernullablerequired

The previous page number, or null if this is the first page.

Example (from schema)

{
  "data": [
    {
      "organization": {
        "id": "abc123",
        "name": "My Organization",
        "plan": {
          "name": "pro_monthly",
          "status": "PENDING"
        }
      },
      "role": "OWNER"
    }
  ],
  "metadata": {
    "currentPage": 1,
    "limit": 10,
    "total": 100,
    "nextPage": 2,
    "previousPage": null
  }
}

Loading...