Gets one or more custom attributes

Supported Formats

json

Errors

Code Description
400 Bad Request: body has wrong syntax or unable to handle request
401 Unauthorized: auth_token omitted or authentication failed
403 Forbidden: This action cannot be performed
404 Not Found: The requested resource could not be found
406 Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Examples

REQUEST
Accept: application/json

RESPONSE
{
  "attributes": [
    {
      "attribute_type": "String",
      "created_at": "2015-07-13T19:53:17Z",
      "id": 12964,
      "name": "awesome",
      "organization_id": 98645,
      "is_public": false,
      "updated_at": "2015-07-13T19:53:17Z"
    },
    {
      "attribute_type": "String",
      "created_at": "2015-07-13T20:31:09Z",
      "id": 45863,
      "name": "a default value",
      "organization_id": 98645,
      "is_public": true,
      "updated_at": "2015-07-13T20:31:09Z"
    }
  ],
  "summary": {
    "page": 1,
    "per_page": 50,
    "count": 2
  }
}

Params

Param name Description
auth_token
optional

API token needed to authorize requests
This can appear as an attribute in the body of the request or the query parameters on the URL

Validations:

  • Must be a String

per_page
optional

The number of items shown per page
Maximum: 200

Validations:

  • Parameter has to be Integer.

page
optional

The page number included in the response
Only applied when per_page is used
Default: 1

Validations:

  • Parameter has to be Integer.