v1
latestOpenAPI 3.0.32026-07-1416063.7 KBGet Attributes
This endpoint retrieves all attributes available to the client. This includes attributes created by the client, as well as any system scoped attributes.
Query parameters
The current page of results to retrieve.
The number of results to pull back. Allowed values: 25, 50, 100, -1 (for all).
The order for record sorting. Allowed values are asc and desc.
The field for sorting records. Allowed values: id, name, scope, type, length, status.
A value to search the name field by for the request.
The scopes to filter results by. Allowed values are system and client.
The value types to filter by. Allowed values are open and predefined.
The subtypes to filter by. Allowed values are email, phone, string, zip, zip_plusfour, numeric_only, alpha_only, alphanumeric_only, boolean.
The statuses to filter by. Allowed values are active and inactive.
Response
200
Example response
{
"data": [
{
"id": 9,
"name": "Phone Number",
"type": "string",
"scope": "client",
"length": 15,
"values_type": "open",
"status": "active",
"subtype": "phone"
}
],
"meta": {
"total": 8,
"count": 8,
"page": 1,
"pages": 1,
"per_page": 25,
"order": "id",
"sort": "DESC"
}
}