--- title: "Fetch role assignments" method: GET path: "/role_assignments" tags: ["Role assignments"] --- # Fetch role assignments `GET /role_assignments` ## Query parameters - `ids` string - `query` string - `limit` integer - `offset` integer - `role_id` string - `assignee_type` 'User' | 'Team' | 'Guest' - `assignee_id` integer - `applies_to_type` 'Organization' | 'Place' | 'Group' - `applies_to_id` integer - `scope` 'organization' | 'place' | 'group' | 'team' - `user_id` union - integer - string - `place_id` integer - `group_id` integer - `sort` 'user.name' | '-user.name' ## Response `200` OK - union[] - union - object - `id` integer, required — The ID of the role assignment - `resource_type` 'RoleAssignment', required — The resource type of the role assignment - `created_at` string, date-time, required — When the role assignment was created - `updated_at` string, date-time, required — When the role assignment was updated - `role_id` string, required — The role ID of the role assignment. - `notify` boolean, required — Whether an email should be sent to the user when this role assignment is created or updated. - `applies_to_type` 'Organization', required - `applies_to_id` integer, required — The applies_to ID of the role assignment - `applies_to` union, required — The applies_to of the role assignment - object - `id` integer, required — The ID of the organization - `resource_type` 'Organization', required — The resource type of the organization - `name` string, required — The name of the organization - `domain` string, required — The domain of the organization. - object - `id` integer, required — The ID of the place - `resource_type` 'Place', required — The resource type of the place - `name` string, required — The name of the place - object - `id` integer, required — The ID of the group - `resource_type` 'Group', required — The resource type of the group - `name` string, required — The name of the group - `assignee_type` 'User' | 'Team' | 'Guest', required — The assignee type of the role assignment - `assignee_id` integer, required — The assignee ID of the role assignment - `assignee` union, required — The assignee of the role assignment - object - `id` integer, required — The ID of the user - `resource_type` 'User', required — The resource type of the user - `email` string, email, required — The email of the user. - `name` string, required — The name of the user - object - `id` integer, required — The ID of the team - `resource_type` 'Team', required — The resource type of the team - `name` string, required — The name of the team - object - `id` integer, required — The ID of the guest - `resource_type` 'Guest', required — The resource type of the guest - `name` string, required — The name of the guest - `email` string, email, nullable, required — The email of the guest. - `phone_number` string, nullable, required — The phone number of the guest. Only US, Canadian and Puerto Rican numbers in the format +11234567890 (E.164) are accepted. - `created_by_type` 'null' | 'User' | 'MarketplaceInstallation', nullable, required — The created_by type of the role assignment - `created_by_id` integer, nullable, required — The created_by ID of the role assignment - `user_id` integer, nullable, required — The user ID of the role assignment - `user` object — The user of the role assignment - `id` integer, required — The ID of the user - `resource_type` 'User', required — The resource type of the user - `email` string, email, required — The email of the user. - `name` string, required — The name of the user - `assignee_team_id` integer, nullable, required — The assignee_team ID of the role assignment - `assignee_team` object — The assignee_team of the role assignment - `id` integer, required — The ID of the team - `resource_type` 'Team', required — The resource type of the team - `name` string, required — The name of the team - `guest_id` integer, nullable, required — The guest ID of the role assignment - `guest` object — The guest of the role assignment - `id` integer, required — The ID of the guest - `resource_type` 'Guest', required — The resource type of the guest - `name` string, required — The name of the guest - `email` string, email, nullable, required — The email of the guest. - `phone_number` string, nullable, required — The phone number of the guest. Only US, Canadian and Puerto Rican numbers in the format +11234567890 (E.164) are accepted. - `issued_by_id` integer, nullable, required — The user ID of the user who created the role assignment. - `type` 'organization', required - `scope` 'organization', required - `organization_id` integer, required — The organization ID of the role assignment - `organization` object, required — The organization of the role assignment - `id` integer, required — The ID of the organization - `resource_type` 'Organization', required — The resource type of the organization - `name` string, required — The name of the organization - `domain` string, required — The domain of the organization. - object - `id` integer, required — The ID of the role assignment - `resource_type` 'RoleAssignment', required — The resource type of the role assignment - `created_at` string, date-time, required — When the role assignment was created - `updated_at` string, date-time, required — When the role assignment was updated - `role_id` string, required — The role ID of the role assignment. - `notify` boolean, required — Whether an email should be sent to the user when this role assignment is created or updated. - `applies_to_type` 'Place', required - `applies_to_id` integer, required — The applies_to ID of the role assignment - `applies_to` union, required — The applies_to of the role assignment - object - `id` integer, required — The ID of the organization - `resource_type` 'Organization', required — The resource type of the organization - `name` string, required — The name of the organization - `domain` string, required — The domain of the organization. - object - `id` integer, required — The ID of the place - `resource_type` 'Place', required — The resource type of the place - `name` string, required — The name of the place - object - `id` integer, required — The ID of the group - `resource_type` 'Group', required — The resource type of the group - `name` string, required — The name of the group - `assignee_type` 'User' | 'Team' | 'Guest', required — The assignee type of the role assignment - `assignee_id` integer, required — The assignee ID of the role assignment - `assignee` union, required — The assignee of the role assignment - object - `id` integer, required — The ID of the user - `resource_type` 'User', required — The resource type of the user - `email` string, email, required — The email of the user. - `name` string, required — The name of the user - object - `id` integer, required — The ID of the team - `resource_type` 'Team', required — The resource type of the team - `name` string, required — The name of the team - object - `id` integer, required — The ID of the guest - `resource_type` 'Guest', required — The resource type of the guest - `name` string, required — The name of the guest - `email` string, email, nullable, required — The email of the guest. - `phone_number` string, nullable, required — The phone number of the guest. Only US, Canadian and Puerto Rican numbers in the format +11234567890 (E.164) are accepted. - `created_by_type` 'null' | 'User' | 'MarketplaceInstallation', nullable, required — The created_by type of the role assignment - `created_by_id` integer, nullable, required — The created_by ID of the role assignment - `user_id` integer, nullable, required — The user ID of the role assignment - `user` object — The user of the role assignment - `id` integer, required — The ID of the user - `resource_type` 'User', required — The resource type of the user - `email` string, email, required — The email of the user. - `name` string, required — The name of the user - `assignee_team_id` integer, nullable, required — The assignee_team ID of the role assignment - `assignee_team` object — The assignee_team of the role assignment - `id` integer, required — The ID of the team - `resource_type` 'Team', required — The resource type of the team - `name` string, required — The name of the team - `guest_id` integer, nullable, required — The guest ID of the role assignment - `guest` object — The guest of the role assignment - `id` integer, required — The ID of the guest - `resource_type` 'Guest', required — The resource type of the guest - `name` string, required — The name of the guest - `email` string, email, nullable, required — The email of the guest. - `phone_number` string, nullable, required — The phone number of the guest. Only US, Canadian and Puerto Rican numbers in the format +11234567890 (E.164) are accepted. - `issued_by_id` integer, nullable, required — The user ID of the user who created the role assignment. - `type` 'place', required - `scope` 'place', required - `place_id` integer, required — The place ID of the role assignment - `place` object, required — The place of the role assignment - `id` integer, required — The ID of the place - `resource_type` 'Place', required — The resource type of the place - `name` string, required — The name of the place - object - `id` integer, required — The ID of the role assignment - `resource_type` 'RoleAssignment', required — The resource type of the role assignment - `created_at` string, date-time, required — When the role assignment was created - `updated_at` string, date-time, required — When the role assignment was updated - `role_id` string, required — The role ID of the role assignment. - `notify` boolean, required — Whether an email should be sent to the user when this role assignment is created or updated. - `applies_to_type` 'Group', required - `applies_to_id` integer, required — The applies_to ID of the role assignment - `applies_to` union, required — The applies_to of the role assignment - object - `id` integer, required — The ID of the organization - `resource_type` 'Organization', required — The resource type of the organization - `name` string, required — The name of the organization - `domain` string, required — The domain of the organization. - object - `id` integer, required — The ID of the place - `resource_type` 'Place', required — The resource type of the place - `name` string, required — The name of the place - object - `id` integer, required — The ID of the group - `resource_type` 'Group', required — The resource type of the group - `name` string, required — The name of the group - `assignee_type` 'User' | 'Team' | 'Guest', required — The assignee type of the role assignment - `assignee_id` integer, required — The assignee ID of the role assignment - `assignee` union, required — The assignee of the role assignment - object - `id` integer, required — The ID of the user - `resource_type` 'User', required — The resource type of the user - `email` string, email, required — The email of the user. - `name` string, required — The name of the user - object - `id` integer, required — The ID of the team - `resource_type` 'Team', required — The resource type of the team - `name` string, required — The name of the team - object - `id` integer, required — The ID of the guest - `resource_type` 'Guest', required — The resource type of the guest - `name` string, required — The name of the guest - `email` string, email, nullable, required — The email of the guest. - `phone_number` string, nullable, required — The phone number of the guest. Only US, Canadian and Puerto Rican numbers in the format +11234567890 (E.164) are accepted. - `created_by_type` 'null' | 'User' | 'MarketplaceInstallation', nullable, required — The created_by type of the role assignment - `created_by_id` integer, nullable, required — The created_by ID of the role assignment - `user_id` integer, nullable, required — The user ID of the role assignment - `user` object — The user of the role assignment - `id` integer, required — The ID of the user - `resource_type` 'User', required — The resource type of the user - `email` string, email, required — The email of the user. - `name` string, required — The name of the user - `assignee_team_id` integer, nullable, required — The assignee_team ID of the role assignment - `assignee_team` object — The assignee_team of the role assignment - `id` integer, required — The ID of the team - `resource_type` 'Team', required — The resource type of the team - `name` string, required — The name of the team - `guest_id` integer, nullable, required — The guest ID of the role assignment - `guest` object — The guest of the role assignment - `id` integer, required — The ID of the guest - `resource_type` 'Guest', required — The resource type of the guest - `name` string, required — The name of the guest - `email` string, email, nullable, required — The email of the guest. - `phone_number` string, nullable, required — The phone number of the guest. Only US, Canadian and Puerto Rican numbers in the format +11234567890 (E.164) are accepted. - `issued_by_id` integer, nullable, required — The user ID of the user who created the role assignment. - `type` 'group', required - `scope` 'group', required - `group_id` integer, required — The group ID of the role assignment - `group` object, required — The group of the role assignment - `id` integer, required — The ID of the group - `resource_type` 'Group', required — The resource type of the group - `name` string, required — The name of the group - `valid_from` string, date-time, nullable, required — When the role assignment starts to be valid. - `valid_until` string, date-time, nullable, required — When the role assignment stops to be valid. ## Other responses - `401` — Unauthorized --- [API](https://skmtc.dev/kisi/apis/kisi-api.md) · [All operations](https://skmtc.dev/kisi/apis/kisi-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/kisi/kisi-api/revisions/998700ffff5a/schema)