Get Category by Name or ID
This endpoint allows you to get a category by its name or ID
Data Types
Object Topic
| Field name | Type | Description |
|---|---|---|
| Id | int | Id of category |
| Name | string | Display name |
Response Object
| Field name | Type | Description |
|---|---|---|
| Topic | Topic | Topic object |
| Success | bool | Indicates whether a request was successful (true) or not (false) |
| Message | string | Error message if success is false |
Request/Response
Path Parameters
| Parameter Name | Type | Description |
|---|---|---|
| id | int | Id of desired category |
| name | string | Name of desired category |
Note: Only one parameter is required
HTTP Request
To retrieve category by ID:
GET https://sentry.bombora.com/v2/Topic/GetCategory?id=1500511
To retrieve category by name:
GET https://sentry.bombora.com/v2/Topic/GetCategory?name=accounting
HTTP Request Header
Authorization: Basic {AUTH_KEY}
Referer: bombora.com
HTTP Response
If successful, the response contains an instance of Topic.
{
"Topic":
{
"Id":1500511,
"Name":"Accounting"
},
"Success":true,
"Message":null
}
Comments
- Ensure special characters in category names are properly encoded.
- If category name is "A & B", request should be sent as:
- GetCategory?name=A%20%26%20B
- If category name is "A & B", request should be sent as:
- Category name or ID is required. If both are supplied, only the category ID will be considered.
Copyright © 2014-2020 by Bombora, Inc. All rights reserved. No part of this publication may be reproduced, distributed, or transmitted in any form or by any means without the prior written permission of Bombora, Inc.