ProZ.com global directory of translation services
The translation workplace
Ideas

GET: /user-list

Get a collection of UserList objects that match a set of criteria.

Required authorization scope

When using OAuth2 access tokens, the userlist scope is required to create an entry. See scopes in the authentication guide for information about how to request this scope of authorization.

Parameters

Search criteria (all are optional besides uuid):
  • uuid: (UUID) Get lists owned by specified UUID. Accepts the special value to me to refer to the authenticated viewer.
  • listed_uuid: (UUID) Get lists of which the specified UUID is added as a member. Useful for determining if the uuid has already added a given listed_uuid to any lists.
  • permission: (string) One of admin, edit, or view. Determines which lists are returned for which the viewer is added as a collaborator, in addition to lists they created. The permissions cascade: admin implies edit and view, and edit implies view.

Example request

curl -H "Authorization: Bearer {OAUTH2_ACCESS_TOKEN}" https://api.proz.com/v2/wiwo?uuid=me&listed_uuid=ad00b4f1-7b79-461d-92bd-57b4373ef1cb

Response

Returns a collection of UserList objects.

{
  "user_lists": [
    {
      "id": 17,
      "parent_id": 3,
      "name": "My Vendors",
      "description": "This is a description of My Vendors list.",
      "users": [
        {
          "id": 46745,
          "link": "https://api.proz.com/v2/users/ad00b4f1-7b79-461d-92bd-57b4373ef1cb",
          "operation": "include"
        }
      ]
    }
  ]
}