Menu

Categories

Elements that can be shared among more than one endpoint definition.

Retrieve all categories

Retrieve all categories

GET /categories

This endpoint allows you to retrieve a list of all of your categories.

Authentication

  • API Key

Headers

Authorization
string
default: Bearer <<YOUR_API_KEY_HERE>>
required
on-behalf-of
string
default: The subuser's username. This header generates the API call as if the subuser account was making the call.

Query String

limit
integer

The number of results to return.

category
string

Allows you to perform a prefix search on this particular category.

offset
integer

The point in the list to begin retrieving results.

Responses

array[object]
category
string

A category used to group emails by broad topic.

object
errors
array[object]

The error returned.

field
string
message
string

A message explaining why your categories could not be retrieved.

Need some help?

We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the SendGrid tag on Stack Overflow.