Taxonomy

Navigate our taxonomy. No authorization required for the endpoints listed below.

Get Categories

This endpoint allows the user to traverse our category tree. Excluding the “parentId” from the URL will return the top level categories.

URLhttps://api.getquipt.com/v2/categories

Methodget

Parameters:

Name	Description	Type	Required
parentId	The parent category id. Supply to retrieve the children categories of the selected category.	Guid	No

Response Definitions:

Name	Description	Type
Result	The collection of categories.	CategoryResult[]
TransactionId	The transaction id for the request.	String
TransactionTime	The time the transaction took place.	DateTime
Success	Whether or not the transaction was successful	Boolean
Messages	One or more messages may accompany the response. It is important to review the Severity of each message to determine the reason for failure.	Message[]

This endpoint allows the user retrieve the custom attributes required for a specific category.

URLhttps://api.getquipt.com/v2/categories/{categoryId}/attributes

Methodget

Parameters:

Name	Description	Type	Required
{categoryId}	The category id.	Guid	Yes

Response Definitions:

Name	Description	Type
Result	The collection of category attributes.	AttributeResult[]
TransactionId	The transaction id for the request.	String
TransactionTime	The time the transaction took place.	DateTime
Success	Whether or not the transaction was successful	Boolean
Messages	One or more messages may accompany the response. It is important to review the Severity of each message to determine the reason for failure.	Message[]

Navigate our taxonomy. No authorization required for the endpoints listed below.

This endpoint allows the user to traverse our category tree. Excluding the “parentId” from the URL will return the top level categories.

URLhttps://api.getquipt.com/v2/categories

Methodget

Parameters:

Name	Description	Type	Required
parentId	The parent category id. Supply to retrieve the children categories of the selected category.	Guid	No

Response Definitions:

Name	Description	Type
Result	The collection of categories.	CategoryResult[]
TransactionId	The transaction id for the request.	String
TransactionTime	The time the transaction took place.	DateTime
Success	Whether or not the transaction was successful	Boolean
Messages	One or more messages may accompany the response. It is important to review the Severity of each message to determine the reason for failure.	Message[]

This endpoint allows the user retrieve the custom attributes required for a specific category.

URLhttps://api.getquipt.com/v2/categories/{categoryId}/attributes

Methodget

Parameters:

Name	Description	Type	Required
{categoryId}	The category id.	Guid	Yes

Response Definitions:

Name	Description	Type
Result	The collection of category attributes.	AttributeResult[]
TransactionId	The transaction id for the request.	String
TransactionTime	The time the transaction took place.	DateTime
Success	Whether or not the transaction was successful	Boolean
Messages	One or more messages may accompany the response. It is important to review the Severity of each message to determine the reason for failure.	Message[]