This API call is used to get information about current Quip user accounts.

This call can be performed with no parameters, in which case all users will be returned, or with a "filter" parameter, which limits the response to a subset of the current users. (Note: if you have a lot of users, you probably don't want to call this without a "count").

Deactivated Users

Deactivated users willl be returned from some calls and not others.

• requests with no filter, and requests that filter by name or username, will not return deactivated users.
• requests that filter by email will return deactivated users.

This API call is used to set up a new Quip user account.

When creating credentials in your identity service for a new employee, you can use this call to automatically set up a new Quip account for that user.

Email Collisions

If you attempt to create a user who has an email that is already associated with an active user at your site, the operation will fail with HTTP status code 409 (Conflict).

If you attempt to create a user who has an email that is already associated with a deactivated user at your site, the prior user will be reactivated by providing active parameter. Other information from your request will be ignored.

This operation can be used to get information for a single user.

Deactivated Users

Data will be returned from this call whether or not the specified user is active.

Update all fields on an existing user.

Notes:

• the primary subfield of a user email cannot be updated using this API; use PATCH /2/Users/:userId instead
• the type subfield of a user email cannot be updated at all. The type of every email is work
• the roles field has been deprecated and shouldn’t be used in the SCIM requests. To adjust admin roles for users, please review the Admin API documentation.

This operation allows specific updates to be made to a user without supplying the whole user definition again.

The structure of this request consists of one or more "operations". Each operation contains:

• an op field. This can be add, replace, or remove
• for add and replace operations, a value field containing the value to use in the operation
• (usually) a path field

Note that if "path" is active, "value" must be true or false, not "true" or "false" - i.e. a boolean, not a string.

The roles field has been deprecated and shouldn’t be used in the SCIM requests. To adjust admin roles for users, please review the Admin API documentation.

Operations With No Path

There's a special format of the add and replace operations that does not require a path. In this case, the field names in the value object specify what is to be changed. See the example patch_without_paths.

This call will disable a user's account, but will not delete it. That user will lose access to Quip and will not be able to log in, but none of their data will be deleted or lost, and any content they shared with other users will remain shared with those users.

To re-enable a user account, use the Update User operation to set the active field back to true.

This API call is used to get information about current Quip user accounts.

This call can be performed with no parameters, in which case all users will be returned, or with a "filter" parameter, which limits the response to a subset of the current users. (Note: if you have a lot of users, you probably don't want to call this without a "count".)

Deactivated Users

Deactivated users willl be returned from some calls and not others.

• requests with no filter, and requests that filter by name or username, will not return deactivated users.
• requests that filter by email will return deactivated users.

This API call is used to set up a new Quip user account.

When creating credentials in your identity service for a new employee, you can use this call to automatically set up a new Quip account for that user.

Email Collisions

If you attempt to create a user who has an email that is already associated with an active user at your site, the operation will fail with HTTP status code 409 (Conflict).

If you attempt to create a user who has an email that is already associated with a deactivated user at your site, the prior user will be reactivated by providing active parameter. Other information from your request will be ignored.

This operation can be used to get information for a single user.

Deactivated Users

Data will be returned from this call whether or not the specified user is active.

Update all fields on an existing user.

Notes:

• the primary subfield of a user email cannot be updated using this API; use PATCH /2/Users/:userId instead
• the type subfield of a user email cannot be updated at all. The type of every email is work.
• the roles field has been deprecated and shouldn’t be used in the SCIM requests. To adjust admin roles for users, please review the Admin API documentation.

This call will disable a user's account, but will not delete it. That user will lose access to Quip and will not be able to log in, but none of their data will be deleted or lost, and any content they shared with other users will remain shared with those users.

To re-enable a user account, use the Update User operation to set the active field back to true.

This operation allows specific updates to be made to a user without supplying the whole user definition again.

The structure of this request consists of one or more "operations". Each operation contains:

• an op field. This can be add, replace, or remove
• for add and replace operations, a value field containing the value to use in the operation
• (usually) a path field

Note that if "path" is active, "value" must be true or false, not "true" or "false" - i.e. a boolean, not a string.

The roles field has been deprecated and shouldn’t be used in the SCIM requests. To adjust admin roles for users, please review the Admin API documentation.

Operations With No Path

There's a special format of the add and replace operations that does not require a path. In this case, the field names in the value object specify what is to be changed. See the example patch_without_paths.

This call will remove access to all threads that were shared with a disabled user.

This API call is used to fetch information about current Quip Group Folders.

By default, all group folders will be returned from this call. The number of results returned with a single request can be chosen using the "count" parameter - this is a good idea if you have a lot of group folders or if your group folders are large.

This operation allows a caller to create a new group folder for the company. A group folder must have at least one member at all times, including when it is created. The group folder will be created as a top level folder for your company and can be further managed using the Admin Console, under Group Folders.

Note: at present, this API returns response messages that contain the incorrect schema value.

This API call can be used to fetch the information on a single group folder, given the group ID.

Note: at present, this API returns response messages that contain the incorrect schema value.

This API call can be used to modify a group, i.e. add and/or remove members, without replacing the entire group. More than one change can be made in a single request. This can be useful for groups with many members.

This API call is used to fetch information about current Quip Group Folders.

By default, all group folders will be returned from this call. The number of results returned with a single request can be chosen using the "count" parameter - this is a good idea if you have a lot of group folders or if your group folders are large.

Note: currently the schema returned from this operation is incorrect.

This operation allows a caller to create a new group folder for the company. A group folder must have at least one member at all times, including when it is created. The group folder will be created as a top level folder for your company and can be further managed using the Admin Console, under Group Folders.

Note: at present, this API returns response messages that contain the incorrect schema value.

This API call can be used to fetch the information on a single group folder, given the group ID.

Note: at present, this API returns response messages that contain the incorrect schema value.

This API call can be used to update a user group — including adding and removing members, and updating user group name. More than one change can be made in a single request. After user group membership is updated, the changes will be reflected in any corresponding group folders.

This API call is used to fetch information about current Quip User Groups.

By default, all user groups will be returned from this call. The number of results returned with a single request can be chosen using the "count" parameter - this is a good idea if you have a lot of user groups or if your user groups are large.

This operation allows a caller to create a new user group for the company. User groups can be used to assign users to group folders by synchronizing the folder on the Quip UI.

This API call can be used to fetch the information on a single user group, given the group ID.

This API call can be used to update a user group — including adding and removing members, and updating user group name. More than one change can be made in a single request. After user group membership is updated, the changes will be reflected in any corresponding group folders.

Deletes all members of a group folder. Deleting a group removes the members access to their corresponding group folder. You can use this API method to fulfill your compliance and user-management service-level agreements (SLAs).

See Also: Folders

This API call is used to fetch information about current Quip User Groups.

By default, all user groups will be returned from this call. The number of results returned with a single request can be chosen using the "count" parameter - this is a good idea if you have a lot of user groups or if your user groups are large.

Note: currently the schema returned from this operation is incorrect.

This operation allows a caller to create a new user group for the company. User groups can be used to assign users to group folders by synchronizing the folder on the Quip UI.

Note: at present, this API returns response messages that contain the incorrect schema value.

This API call can be used to fetch the information on a single user group, given the group ID.

Note: at present, this API returns response messages that contain the incorrect schema value.

This API call can be used to update a user group — including adding and removing members, and updating user group name. More than one change can be made in a single request. After user group membership is updated, the changes will be reflected in any corresponding group folders.

Deletes all members of a group folder. Deleting a group removes the members access to their corresponding group folder. You can use this API method to fulfill your compliance and user-management service-level agreements (SLAs).

See Also: Folders

This bulk API call is used to get status information about user merge requests. It will return a status of PENDING, COMPLETE, FAILED or NOT FOUND. A status of FAILED has a corresponding error_message field to indicate why the request failed. This API has a maximum batch size of 50.

This bulk API call is used to enqueue new user merge requests. A merge request merges two users and transfers data from the source user to the target user. The source user is disabled and deleted after the merge and the source user's email address is added to the target user's account. You can merge a disabled account into an active account, but two disabled accounts cannot be merged.

This API accepts multiple merge requests with a maximum batch size of 50. Please use this API cautiously as a merge is irreversible.

Note: We recommend not submitting concurrent requests with the same user involved as a user can go through only one merge at a time. The recommended wait period is about 24 hours. If you do submit concurrent requests with the same user, the latter requests would eventually fail.

This call will transfer the private documents from the source user to the target user. The source user must be disabled prior to transferring content.

This API returns Quip's configuration details for our SCIM API. For more details please refer https://simplecloud.info/specs/draft-scim-core-schema-01.html#anchor11