Custom Roles API reference

Reference map for Custom Roles API operations.

Updated
Apr 26, 2026

Custom Roles

Use this reference map to choose the operation group before opening an endpoint page for exact request and response details.

Use Custom Roles when the job is trusted administration of merchant role records.

Custom role operations own paginated listing, reads, creation, updates, and deletion. Use Merchant Users when the job is assigning or managing the merchant-facing user account rather than changing the role record.

For workflow guidance across custom roles, third-party links, scheduling, logs, and shareable links, see Operational controls and external handoffs.

Read and inspect

OperationAPI
Get a custom roleManagement API
List all custom roles within paginationManagement API

Create or attach

OperationAPI
Create a custom roleManagement API

Update or repair

OperationAPI
Update a custom roleManagement API

Remove or deactivate

OperationAPI
Delete a custom roleManagement API

Custom Roles API reference

# Custom Roles Use this reference map to choose the operation group before opening an endpoint page for exact request and response details. Use Custom Roles when the job is trusted administration of merchant role records. Custom role operations own paginated listing, reads, creation, updates, and deletion. Use Merchant Users when the job is assigning or managing the merchant-facing user account rather than changing the role record. For workflow guidance across custom roles, third-party links, scheduling, logs, and shareable links, see [Operational controls and external handoffs](/start/concepts/operational-controls-and-external-handoffs).

5 operations grouped by the job they support.

## Read and inspect | Operation | API | | --- | --- | | [Get a custom role](/reference/customroles/get-a-custom-role) | Management API | | [List all custom roles within pagination](/reference/customroles/list-all-custom-roles-within-pagination) | Management API | ## Create or attach | Operation | API | | --- | --- | | [Create a custom role](/reference/customroles/create-a-custom-role) | Management API | ## Update or repair | Operation | API | | --- | --- | | [Update a custom role](/reference/customroles/update-a-custom-role) | Management API | ## Remove or deactivate | Operation | API | | --- | --- | | [Delete a custom role](/reference/customroles/delete-a-custom-role) | Management API |