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

Get Role

GET
https://app.polytomic.com/api/permissions/roles/:id
GET
/api/permissions/roles/:id
$curl https://app.polytomic.com/api/permissions/roles/248df4b7-aa70-47b8-a036-33ac447e668d \
>     -H "X-Polytomic-Version: X-Polytomic-Version" \
>     -u "<username>:<password>"
1{
2  "data": {
3    "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
4    "name": "Custom",
5    "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
6    "system": false
7  }
8}

Returns a single permissions role by ID.

Returns the role’s name, action set, and whether it is a built-in system role.

Was this page helpful?
Previous

Delete Role

Next

Authentication

AuthorizationBasic

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

OR
AuthorizationBearer
This is the Polytomic API key

Path parameters

idstringRequiredformat: "uuid"

Headers

X-Polytomic-VersionstringRequired

Response

OK
dataobject

Errors

401
Unauthorized Error
404
Not Found Error