Menu

Subusers API

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

List all Subusers

List all Subusers

GET /subusers

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

You can choose to retrieve specific subusers as well as limit the results that come back from the API.

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

The number of results to return.

default: None
offset
integer

The point in the list to begin retrieving results.

default: None

Responses

array[object]
disabled
boolean

Whether or not the user is enabled or disabled.

id
number

The ID of this subuser.

username
string

The name by which this subuser will be referred.

email
string

The email address to contact this subuser.

format: email
object
errors
array[object]
message
string

the error message

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"
    }
  ]
}
Rate this page:

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.

Thank you for your feedback!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

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

Thanks for your feedback!

Refer us and get $10 in 3 simple steps!

Step 1

Get link

Get a free personal referral link here

Step 2

Give $10

Your user signs up and upgrade using link

Step 3

Get $10

1,250 free SMSes
OR 1,000 free voice mins
OR 12,000 chats
OR more