Menu

Expand
Rate this page:

Subusers API

For more information about Subusers, visit the longform Subusers documentation. You can also manage Subusers in the SendGrid console.

List all Subusers

GET /v3/subusers

Base url: https://api.sendgrid.com

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

You can use the username query parameter to filter the list for specific subusers.

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.

Authentication

  • API Key

Headers

Authorization
string
default: Bearer <<YOUR_API_KEY_HERE>>
required

Query String

username
string

The username of this subuser.

default: None
limit
integer

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.

default: None
offset
integer

The number of items in the list to skip over before starting to retrieve the items for the requested page. The default offset of 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. An offset of 10 requests the second page, an offset of 20 requests the third page and so on, provided there are sufficiently many items in your list.

default: 0

Responses

array[object]
disabled
boolean

Whether or not the user is enabled or disabled.

required
id
number

The ID of this subuser.

required
username
string

The name by which this subuser will be referred.

required
email
string

The email address to contact this subuser.

format: email
required
object
errors
array[object]
message
string

the error message

required
field
string or null

the field that generated the error

help
object

helper text or docs for troubleshooting

id
string
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

Retrieving paginated results

To perform a request for the first page of the paginated list of all subusers using the default page size, you can omit the limit and offset query parameters:

Loading Code Sample...
        
        

        Retrieve first page from list of all subusers

        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 offset:

        Loading Code Sample...
              
              

              Retrieve first page from list of all subusers with a specified page size

              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:

              Loading Code Sample...
                    
                    
                    Using the offset query parameter in combination with the limit query parameter

                    Retrieve a specific page from the list of all subusers

                    Using the offset query parameter in combination with the limit query parameter
                    Rate this page:

                    Need some help?

                    We all do sometimes. Get help now from the Twilio SendGrid Support Team.

                    Running into a coding hurdle? Lean on the wisdom of the crowd by browsing the SendGrid tag on Stack Overflow or visiting Twilio's Stack Overflow Collective.

                    Loading Code Sample...
                          
                          
                          

                          Thank you for your feedback!

                          Please select the reason(s) for your feedback. The additional information you provide helps us improve our documentation:

                          Sending your feedback...
                          🎉 Thank you for your feedback!
                          Something went wrong. Please try again.

                          Thanks for your feedback!

                          thanks-feedback-gif