Organization

Here you can find information about all API commands and queries related to organizations.

Queries

---

get_organization

Get organization details.

Parameters

• id (required): The ID of the organization.

Example

curl -X POST 'https://app.polyteia.com/api' \
    -header "Content-Type: application/json" \
    -header "Authorization: Bearer <your_access_token>" \
    --data '{
        "query": "get_organization",
        "params": {
            "id": "org_cv33u4n0i6q45p93i930"
        }
    }'

Organization Response

• id: The ID of the organization.

• created_at: The date and time when the organization was created.

• updated_at: The date and time when the organization was last updated.

• name: The name of the organization.

• description: The description of the organization.

• slug: The slug of the organization.

Example Response

{
    "data": {
        "id": "org_cv33u4n0i6q45p93i930",
        "created_at": "2025-03-24T15:12:49.186202Z",
        "updated_at": "2025-03-24T20:01:59.408382Z",
        "name": "Polyteia",
        "description": "Polyteia organization managed by Polyteia GmbH",
        "slug": "polyteia"
    }
}

---

list_organizations

Paginated list of all organizations subject to the user's access rights.

Parameters

• page (required): The page number to return. minimum: 1

• size (required): The number of items to return per page. minimum: 1, maximum: 100

Example

curl -X POST 'https://app.polyteia.com/api' \
    -header "Content-Type: application/json" \
    -header "Authorization: Bearer <your_access_token>" \
    --data '{
        "query": "list_organizations",
        "params": {
            "page": 1,
            "size": 10
        }
    }'

Response

• total: The total number of organizations subject to the user's access rights.

• page: The current page number.

• size: The number of items requested per page.

• items: An array of organizations. See Organization Response for more details.

Example Response

{
    "data": {
        "total": 1,
        "page": 1,
        "size": 100,
        "items": [
            {
                "id": "org_cv33u4n0i6q45p93i930",
                "created_at": "2025-03-24T15:12:49.186202Z",
                "updated_at": "2025-03-24T20:01:59.408382Z",
                "name": "Polyteia",
                "description": "Polyteia organization managed by Polyteia GmbH",
                "slug": "polyteia"
            }
        ]
    }
}