For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inBook a demo
  • Getting started
    • Introduction
    • Obtaining API keys
    • Quickstart
    • Native clients
    • Concepts
    • Embedding authentication
    • Versioning
    • Idempotent requests
    • Events
  • Configuring your connections
    • CDC streaming from databases
  • Code examples
    • Bulk sync (ELT) from HubSpot to PostgreSQL
    • Bulk sync (ELT) from Salesforce to S3
    • Bulk sync (ELT) from Salesforce to Snowflake
    • Model sync (Reverse ETL) from MongoDB to Salesforce
  • API Reference
        • GETList Roles
        • POSTCreate Role
        • GETGet Role
        • DELDelete Role
        • PATCHUpdate Role
Logo
Log inBook a demo
API ReferencePermissionsRoles

List Roles

GET
https://app.polytomic.com/api/permissions/roles
GET
/api/permissions/roles
$curl https://app.polytomic.com/api/permissions/roles \
>     -H "X-Polytomic-Version: X-Polytomic-Version" \
>     -u "<username>:<password>"
1{
2  "data": [
3    {
4      "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
5      "name": "Custom",
6      "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
7      "system": false
8    }
9  ]
10}
Lists all permissions roles available in the caller's organization, including built-in system roles. System roles such as Admin and Member are always present in every organization and cannot be modified or deleted. Custom roles appear alongside them and can be created, updated, or removed as needed. To inspect or modify a specific role, use [`GET /api/permissions/roles/{id}`](../../../api-reference/permissions/roles/get).
Was this page helpful?
Previous

Create Role

Next

Lists all permissions roles available in the caller’s organization, including built-in system roles.

System roles such as Admin and Member are always present in every organization and cannot be modified or deleted. Custom roles appear alongside them and can be created, updated, or removed as needed.

To inspect or modify a specific role, use GET /api/permissions/roles/{id}.

Authentication

AuthorizationBasic

This is the Polytomic deployment key (on-premises only)

OR
AuthorizationBearer
This is the Polytomic API key

Headers

X-Polytomic-VersionstringRequired

Response

OK
datalist of objects or null

Errors

401
Unauthorized Error
500
Internal Server Error