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

GET: /user-list/:id

Get a single UserList object by ID.

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

  • id: The UserList ID.

Example request

curl -H "Authorization: Bearer {OAUTH2_ACCESS_TOKEN}" https://api.proz.com/v2/user-list/17

Response

A JSON object with the following property:

  • user_list: The requested UserList object.
{
  "user_list": {
  "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"
    },
    {
      "id": 105392,
      "link": "https://api.proz.com/v2/users/74d33be4-43d0-4789-8d81-9a60eca97ba9",
      "operation": "include"
    },
    {
      "id": 72743,
      "link": "https://api.proz.com/v2/users/6e4f5d74-e38a-425f-a98e-ed59c6cd9a72",
      "operation": "exclude"
    }
  ]
}
}