Querying for attributes

Use the following endpoints to query for attributes:

• GET /admin/v1/attributes
• GET /admin/v1/attributes/{attributeId}

The first endpoint retrieves a collection of attributes and their details. For example, the following request retrieves all the available attributes in BillingCenter.

Command

GET /admin/v1/attributes

Response

{
    "count": 2,
    "data": [
        {
            "attributes": {
                "description": "Auto Expertise",
                "id": "xc:S2b-p7gTyL5RU-aF33kWg",
                "name": "Auto-Expertise",
                "type": {
                    "code": "default",
                    "name": "Default"
                }
            }
        },
        {
            "attributes": {
                "description": "Spanish Fluency",
                "id": "xc:SPhpXiegc0R8SqTsSrL4y",
                "name": "Spanish",
                "type": {
                    "code": "default",
                    "name": "Default"
                }
            }
        }
    ]
}

You can use an attribute's id from the response to retrieve that specific attribute. For example, the following request retrieves information about the attribute xc:SPhpXiegc0R8SqTsSrL4y in BillingCenter:

Command

GET /admin/v1/xc:SPhpXiegc0R8SqTsSrL4y

Response

{
    "data": {
        "attributes": {
            "description": "Spanish Fluency",
            "id": "xc:SPhpXiegc0R8SqTsSrL4y",
            "name": "Spanish",
            "type": {
                "code": "default",
                "name": "Default"
         }
     }
}