Elements that can be shared among more than one endpoint definition.
Effective February 1, 2022, Twilio SendGrid will limit the number of stored category statistics available per user. Accounts on a paid plan will be allowed 1,000 categories daily. Accounts on a free plan will be allowed 100 categories daily. For more information about this change, see the Limitations section of our "Working with Categories" page.
Category statistics are available for the previous thirteen months only.
Base url: https://api.sendgrid.com
This endpoint allows you to retrieve a paginated list of all of your categories.
You can use the
limit query parameter to set the page size. If your list contains more items than the page size permits, you can make multiple requests. Use the
offset query parameter to control the position in the list from which to start retrieving additional items.
- API Key
on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g.,
on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g.,
on-behalf-of: <subuser-username>). See On Behalf Of for more information.
limit sets the page size, i.e. maximum number of items from the list to be returned for a single API request. If omitted, the default page size is used.
Allows you to perform a prefix search on this particular category.default: None
The number of items in the list to skip over before starting to retrieve the items for the requested page. The default
0 represents the beginning of the list, i.e. the start of the first page. To request the second page of the list, set the
offset to the page size as determined by
limit. Use multiples of the page size as your
offset to request further consecutive pages. E.g. assume your page size is set to
10 requests the second page, an
20 requests the third page and so on, provided there are sufficiently many items in your list.
A category used to group emails by broad topic.
The error returned.
A message explaining why your categories could not be retrieved.
To perform a request for the first page of the paginated list of all categories using the default page size, you can omit the
offset query parameters:
If you want to specify a page size of your choice, you can use the
limit query parameter. Assume you want a page size of no more than 5 items per request, to retrieve the first page you can use the
limit parameter without specifying an
If you want to retrieve items beyond the first page, you can use the
offset parameter as follows. Assume you are still working with a page size of 5 as determined by your
limit query parameter and you have more than 15 items. To request the fourth page of items, you can use the
offset parameter to skip over the first 15 items, i.e. you start retrieving items starting after the first three pages of 5 items each: