Get Topic by Name or ID

This endpoint allows you to get a topic by its name or ID

Data Types

Object Topic

Field name	Type	Description
Id	int	Id of topic
Name	string	Display name
Description	string	Description of topic

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 topic
name	string	Name of desired topic

Note: Only one parameter is required

HTTP Request

To retrieve topic by topic ID:

GET https://sentry.bombora.com/v2/Topic/GetTopic?id=1333536

To retrieve topic by topic name:

GET https://sentry.bombora.com/v2/Topic/GetTopic?name=legal

HTTP Request Header

Authorization: Basic {AUTH_KEY}
Referer: bombora.com

HTTP Response

If successful, the response contains an instance of Topic.

{
"Topic":
{
"Id":1333536,
"Name":"Legal",
"Description":"Of, based on, or concerned with the law"
},
"Success":true,
"Message":null
}

Comments

Ensure special characters in topic names are properly encoded.
- If topic name is "A & B", request should be sent as:
  - GetTopic?name=A%20%26%20B
Topic name or ID is required. If both are supplied, only the topic 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.