Description

Get a list of all of the Categories on an account.

URI

/api/account/{accountId}/configuration/le-categories/categories?v=2.0

HTTP Methods

GET

Response Codes

200 OK

400 Bad Request

401 Not Authorized

404 Data not found

500 Internal server error

Formats

JSON

Path Parameters

Parameter Description Notes
accountId LP site id Validation fail error code: 400
Type: String

Query Parameters

Parameter Description Notes
v API version 2.0 is the current version
select dynamic selection of response fields Default: $summary alias: id,deleted,name
Available aliases: $all: id,deleted,name,order,proposed $summary: id,deleted,name
type: YOGA 'gdata' dialect
validation error: 400
supported fields: any in response body
**yoga GData dialect builder url: https://github.com/skyscreamer/yoga/wiki/Using-the-Selector-Builder-GUI
include_deleted Whether include deleted items in the response or not Default: false

Request Headers

Header Description
Authorization Contains token string to allow request authentication and authorization. See the doc for more details.

Request Body

N/A

Response Headers

Header Description
ac-revision This parameter specifies the version of the data object retrieved. You can use the If-Match parameter in the request to retrieve a specifc version using this parameter's value.

Response Body

[ { "id": 1, "deleted": false, "name": "iPhone4", "order": 1, "proposed": true }, { "id": 2, "deleted": false, "name": "iPhone5", "order": 2, "proposed": true } ]
Attribute Description Notes
id Account Config object’s unique id. Required Type: long number
name Value of Category name Type: string
deleted Whether the item is deleted or not Type: boolean
order Sorting order of category Type: number
proposed Category might be marked as proposed, this means every engagement will be assigned to it upon creation. Type:boolean Default: false