teamUserGroups.md

Team Users API

List team user groups

https://app.lokalise.com/api2docs/curl/#transition-list-all-groups-get

$response = $client->teamUserGroups->list(
    $teamId,
    [
        'limit' => 20,
        'page' => 1,
    ]
);

$response = $client->teamUserGroups->fetchAll($teamId);

Create a team user group

https://app.lokalise.com/api2docs/curl/#transition-create-a-group-post

$response = $client->teamUserGroups->create(
    $teamId, 
    [
        'name' => 'Proofreaders',
        'is_reviewer' => true,
        'is_admin' => false,
        'admin_rights' => [],
        'languages' => [
            'reference'=> [],
            'contributable'=> [640]
        ]
    ]
);

Retrieve a team user group

https://app.lokalise.com/api2docs/curl/#transition-retrieve-a-group-get

$response = $client->teamUserGroups->retrieve($teamId, $groupId);

Update a team user group

https://app.lokalise.com/api2docs/curl/#transition-update-a-group-put

$response = $client->teamUserGroups->update(
    $teamId,
    $groupId,
    [
            'name' => 'Proofreading admins',
            'is_reviewer'=> true,
            'is_admin'=> true,
            'admin_rights'=> [
                'upload',
                'download',
                'tasks',
                'contributors',
                'screenshots',
                'manage_keys',
                'manage_languages',
                'settings',
                'activity',
                'statistics'
            ],
            'languages' => [
                'reference'=> [],
                'contributable'=> []
            ]
        }
    ]

Delete a team user group

https://app.lokalise.com/api2docs/curl/#transition-delete-a-group-delete

$response = $client->teamUserGroups->delete($teamId, $groupId);

Add projects to team user group

https://app.lokalise.com/api2docs/curl/#transition-add-projects-to-group-put

$response = $client->teamUserGroups->addProjects(
    $teamId,
    $groupId,
    [
        'projects' => [
            '598901215bexxx43dcba74.xxx',
        ],
    ]

Remove projects from team user group

https://app.lokalise.com/api2docs/curl/#transition-remove-projects-from-group-put

$response = $client->teamUserGroups->removeProjects(
    $teamId,
    $groupId,
    [
        'projects' => [
            '598901215bexxx43dcba74.xxx',
        ],
    ]

Add members to team user group

https://app.lokalise.com/api2docs/curl/#transition-add-members-to-group-put

$response = $client->teamUserGroups->addMembers(
    $teamId,
    $groupId,
    [
        'users' => [
            12345,
        ],
    ]

Remove projects from team user group

https://app.lokalise.com/api2docs/curl/#transition-remove-members-from-group-put

$response = $client->teamUserGroups->removeMembers(
    $teamId,
    $groupId,
    [
        'users' => [
            12345,
        ],
    ]

⇚ Back