How do I install the Sendgrid full reference skill?

Run npx skillmds@latest add tools-only/sendgrid-full-reference in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.

What does the Sendgrid full reference skill do?

This is the full reference documentation for the Sendgrid agent connector. It is listed under Coding & Dev Tools on SkillMD.

Is Sendgrid full reference safe to use?

This skill has not completed SkillMD's automated safety review yet. Independent scanners report: SkillSpector: PASS, Skill Scanner: PASS. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with Sendgrid full reference?

This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.

Is Sendgrid full reference free to use?

Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.

Who published Sendgrid full reference?

tools-only (@tools-only) published this skill. Their other Agent Skills are listed on their SkillMD profile.

Sendgrid full reference by tools-only

Name: Sendgrid full reference
Author: tools-only

Sendgrid full reference

This is the full reference documentation for the Sendgrid agent connector.

Supported entities and actions

The Sendgrid connector supports the following entities and actions.

Entity	Actions
Contacts	List, Get, Search
Lists	List, Get, Search
Segments	List, Get, Search
Campaigns	List, Search
Singlesends	List, Get, Search
Templates	List, Get, Search
Singlesend Stats	List, Search
Bounces	List, Search
Blocks	List, Search
Spam Reports	List
Invalid Emails	List, Search
Global Suppressions	List, Search
Suppression Groups	List, Get, Search
Suppression Group Members	List, Search

Contacts

Contacts List

Returns a sample of contacts. Use the export endpoint for full lists.

Python SDK

await sendgrid.contacts.list()

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "contacts",
    "action": "list"
}'

Records

Field Name	Type	Description
`id`	`string`
`email`	`null \| string`
`first_name`	`null \| string`
`last_name`	`null \| string`
`unique_name`	`null \| string`
`alternate_emails`	`null \| array`
`address_line_1`	`null \| string`
`address_line_2`	`null \| string`
`city`	`null \| string`
`state_province_region`	`null \| string`
`country`	`null \| string`
`postal_code`	`null \| string`
`phone_number`	`null \| string`
`whatsapp`	`null \| string`
`line`	`null \| string`
`facebook`	`null \| string`
`list_ids`	`null \| array`
`segment_ids`	`null \| array`
`custom_fields`	`null \| object`
`created_at`	`null \| string`
`updated_at`	`null \| string`

Contacts Get

Returns the full details and all fields for the specified contact.

Python SDK

await sendgrid.contacts.get(
    id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "contacts",
    "action": "get",
    "params": {
        "id": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
`id`	`string`	Yes	The ID of the contact

Records

Field Name	Type	Description
`id`	`string`
`email`	`null \| string`
`first_name`	`null \| string`
`last_name`	`null \| string`
`unique_name`	`null \| string`
`alternate_emails`	`null \| array`
`address_line_1`	`null \| string`
`address_line_2`	`null \| string`
`city`	`null \| string`
`state_province_region`	`null \| string`
`country`	`null \| string`
`postal_code`	`null \| string`
`phone_number`	`null \| string`
`whatsapp`	`null \| string`
`line`	`null \| string`
`facebook`	`null \| string`
`list_ids`	`null \| array`
`segment_ids`	`null \| array`
`custom_fields`	`null \| object`
`created_at`	`null \| string`
`updated_at`	`null \| string`

Contacts Search

Search and filter contacts records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.

Python SDK

await sendgrid.contacts.search(
    query={"filter": {"eq": {"address_line_1": "<str>"}}}
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "contacts",
    "action": "search",
    "params": {
        "query": {"filter": {"eq": {"address_line_1": "<str>"}}}
    }
}'

Parameters

Parameter Name	Type	Required	Description
`query`	`object`	Yes	Filter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, like, fuzzy, keyword, not, and, or
`query.filter`	`object`	No	Filter conditions
`query.sort`	`array`	No	Sort conditions
`limit`	`integer`	No	Maximum results to return (default 1000)
`cursor`	`string`	No	Pagination cursor from previous response's `meta.cursor`
`fields`	`array`	No	Field paths to include in results

Searchable Fields

Field Name	Type	Description
`address_line_1`	`string`	Address line 1
`address_line_2`	`string`	Address line 2
`alternate_emails`	`array`	Alternate email addresses
`city`	`string`	City
`contact_id`	`string`	Unique contact identifier used by Airbyte
`country`	`string`	Country
`created_at`	`string`	When the contact was created
`custom_fields`	`object`	Custom field values
`email`	`string`	Contact email address
`facebook`	`string`	Facebook ID
`first_name`	`string`	Contact first name
`last_name`	`string`	Contact last name
`line`	`string`	LINE ID
`list_ids`	`array`	IDs of lists the contact belongs to
`phone_number`	`string`	Phone number
`postal_code`	`string`	Postal code
`state_province_region`	`string`	State, province, or region
`unique_name`	`string`	Unique name for the contact
`updated_at`	`string`	When the contact was last updated
`whatsapp`	`string`	WhatsApp number

Field Name	Type	Description
`data`	`array`	List of matching records
`meta`	`object`	Pagination metadata
`meta.has_more`	`boolean`	Whether additional pages are available
`meta.cursor`	`string \| null`	Cursor for next page of results
`meta.took_ms`	`number \| null`	Query execution time in milliseconds
`data[].address_line_1`	`string`	Address line 1
`data[].address_line_2`	`string`	Address line 2
`data[].alternate_emails`	`array`	Alternate email addresses
`data[].city`	`string`	City
`data[].contact_id`	`string`	Unique contact identifier used by Airbyte
`data[].country`	`string`	Country
`data[].created_at`	`string`	When the contact was created
`data[].custom_fields`	`object`	Custom field values
`data[].email`	`string`	Contact email address
`data[].facebook`	`string`	Facebook ID
`data[].first_name`	`string`	Contact first name
`data[].last_name`	`string`	Contact last name
`data[].line`	`string`	LINE ID
`data[].list_ids`	`array`	IDs of lists the contact belongs to
`data[].phone_number`	`string`	Phone number
`data[].postal_code`	`string`	Postal code
`data[].state_province_region`	`string`	State, province, or region
`data[].unique_name`	`string`	Unique name for the contact
`data[].updated_at`	`string`	When the contact was last updated
`data[].whatsapp`	`string`	WhatsApp number

Lists

Lists List

Returns all marketing contact lists.

Python SDK

await sendgrid.lists.list()

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "lists",
    "action": "list"
}'

Parameters

Parameter Name	Type	Required	Description
`page_size`	`integer`	No	Maximum number of lists to return

Records

Field Name	Type	Description
`id`	`string`
`name`	`string`
`contact_count`	`integer`
`_metadata`	`null \| object`

Meta

Field Name	Type	Description
`next`	`null \| string`

Lists Get

Returns a specific marketing list by ID.

Python SDK

await sendgrid.lists.get(
    id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "lists",
    "action": "get",
    "params": {
        "id": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
`id`	`string`	Yes	The ID of the list

Records

Field Name	Type	Description
`id`	`string`
`name`	`string`
`contact_count`	`integer`
`_metadata`	`null \| object`

Lists Search

Search and filter lists records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.

Python SDK

await sendgrid.lists.search(
    query={"filter": {"eq": {"_metadata": {}}}}
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "lists",
    "action": "search",
    "params": {
        "query": {"filter": {"eq": {"_metadata": {}}}}
    }
}'

Parameters

Parameter Name	Type	Required	Description
`query`	`object`	Yes	Filter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, like, fuzzy, keyword, not, and, or
`query.filter`	`object`	No	Filter conditions
`query.sort`	`array`	No	Sort conditions
`limit`	`integer`	No	Maximum results to return (default 1000)
`cursor`	`string`	No	Pagination cursor from previous response's `meta.cursor`
`fields`	`array`	No	Field paths to include in results

Searchable Fields

Field Name	Type	Description
`_metadata`	`object`	Metadata about the list resource
`contact_count`	`integer`	Number of contacts in the list
`id`	`string`	Unique list identifier
`name`	`string`	Name of the list

Field Name	Type	Description
`data`	`array`	List of matching records
`meta`	`object`	Pagination metadata
`meta.has_more`	`boolean`	Whether additional pages are available
`meta.cursor`	`string \| null`	Cursor for next page of results
`meta.took_ms`	`number \| null`	Query execution time in milliseconds
`data[]._metadata`	`object`	Metadata about the list resource
`data[].contact_count`	`integer`	Number of contacts in the list
`data[].id`	`string`	Unique list identifier
`data[].name`	`string`	Name of the list

Segments

Segments List

Returns all segments (v2).

Python SDK

await sendgrid.segments.list()

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "segments",
    "action": "list"
}'

Records

Field Name	Type	Description
`id`	`string`
`name`	`string`
`contacts_count`	`integer`
`created_at`	`null \| string`
`updated_at`	`null \| string`
`sample_updated_at`	`null \| string`
`next_sample_update`	`null \| string`
`parent_list_ids`	`null \| array`
`query_version`	`string`
`status`	`null \| object`

Segments Get

Returns a specific segment by ID.

Python SDK

await sendgrid.segments.get(
    segment_id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "segments",
    "action": "get",
    "params": {
        "segment_id": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
`segment_id`	`string`	Yes	The ID of the segment

Records

Field Name	Type	Description
`id`	`string`
`name`	`string`
`contacts_count`	`integer`
`created_at`	`null \| string`
`updated_at`	`null \| string`
`sample_updated_at`	`null \| string`
`next_sample_update`	`null \| string`
`parent_list_ids`	`null \| array`
`query_version`	`string`
`status`	`null \| object`

Segments Search

Search and filter segments records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.

Python SDK

await sendgrid.segments.search(
    query={"filter": {"eq": {"contacts_count": 0}}}
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "segments",
    "action": "search",
    "params": {
        "query": {"filter": {"eq": {"contacts_count": 0}}}
    }
}'

Parameters

Parameter Name	Type	Required	Description
`query`	`object`	Yes	Filter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, like, fuzzy, keyword, not, and, or
`query.filter`	`object`	No	Filter conditions
`query.sort`	`array`	No	Sort conditions
`limit`	`integer`	No	Maximum results to return (default 1000)
`cursor`	`string`	No	Pagination cursor from previous response's `meta.cursor`
`fields`	`array`	No	Field paths to include in results

Searchable Fields

Field Name	Type	Description
`contacts_count`	`integer`	Number of contacts in the segment
`created_at`	`string`	When the segment was created
`id`	`string`	Unique segment identifier
`name`	`string`	Segment name
`next_sample_update`	`string`	When the next sample update will occur
`parent_list_ids`	`array`	IDs of parent lists
`query_version`	`string`	Query version used
`sample_updated_at`	`string`	When the sample was last updated
`status`	`object`	Segment status details
`updated_at`	`string`	When the segment was last updated

Field Name	Type	Description
`data`	`array`	List of matching records
`meta`	`object`	Pagination metadata
`meta.has_more`	`boolean`	Whether additional pages are available
`meta.cursor`	`string \| null`	Cursor for next page of results
`meta.took_ms`	`number \| null`	Query execution time in milliseconds
`data[].contacts_count`	`integer`	Number of contacts in the segment
`data[].created_at`	`string`	When the segment was created
`data[].id`	`string`	Unique segment identifier
`data[].name`	`string`	Segment name
`data[].next_sample_update`	`string`	When the next sample update will occur
`data[].parent_list_ids`	`array`	IDs of parent lists
`data[].query_version`	`string`	Query version used
`data[].sample_updated_at`	`string`	When the sample was last updated
`data[].status`	`object`	Segment status details
`data[].updated_at`	`string`	When the segment was last updated

Campaigns

Campaigns List

Returns all marketing campaigns.

Python SDK

await sendgrid.campaigns.list()

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "campaigns",
    "action": "list"
}'

Parameters

Parameter Name	Type	Required	Description
`page_size`	`integer`	No	Maximum number of campaigns to return per page

Records

Field Name	Type	Description
`id`	`string`
`name`	`string`
`status`	`string`
`channels`	`null \| array`
`is_abtest`	`boolean`
`created_at`	`null \| string`
`updated_at`	`null \| string`

Meta

Field Name	Type	Description
`next`	`null \| string`

Campaigns Search

Search and filter campaigns records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.

Python SDK

await sendgrid.campaigns.search(
    query={"filter": {"eq": {"channels": []}}}
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "campaigns",
    "action": "search",
    "params": {
        "query": {"filter": {"eq": {"channels": []}}}
    }
}'

Parameters

Parameter Name	Type	Required	Description
`query`	`object`	Yes	Filter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, like, fuzzy, keyword, not, and, or
`query.filter`	`object`	No	Filter conditions
`query.sort`	`array`	No	Sort conditions
`limit`	`integer`	No	Maximum results to return (default 1000)
`cursor`	`string`	No	Pagination cursor from previous response's `meta.cursor`
`fields`	`array`	No	Field paths to include in results

Searchable Fields

Field Name	Type	Description
`channels`	`array`	Channels for this campaign
`created_at`	`string`	When the campaign was created
`id`	`string`	Unique campaign identifier
`is_abtest`	`boolean`	Whether this campaign is an A/B test
`name`	`string`	Campaign name
`status`	`string`	Campaign status
`updated_at`	`string`	When the campaign was last updated

Field Name	Type	Description
`data`	`array`	List of matching records
`meta`	`object`	Pagination metadata
`meta.has_more`	`boolean`	Whether additional pages are available
`meta.cursor`	`string \| null`	Cursor for next page of results
`meta.took_ms`	`number \| null`	Query execution time in milliseconds
`data[].channels`	`array`	Channels for this campaign
`data[].created_at`	`string`	When the campaign was created
`data[].id`	`string`	Unique campaign identifier
`data[].is_abtest`	`boolean`	Whether this campaign is an A/B test
`data[].name`	`string`	Campaign name
`data[].status`	`string`	Campaign status
`data[].updated_at`	`string`	When the campaign was last updated

Singlesends

Singlesends List

Returns all single sends.

Python SDK

await sendgrid.singlesends.list()

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "singlesends",
    "action": "list"
}'

Parameters

Parameter Name	Type	Required	Description
`page_size`	`integer`	No	Maximum number of single sends to return per page

Records

Field Name	Type	Description
`id`	`string`
`name`	`string`
`status`	`string`
`categories`	`null \| array`
`send_at`	`null \| string`
`send_to`	`null \| object`
`email_config`	`null \| object`
`is_abtest`	`boolean`
`created_at`	`string`
`updated_at`	`string`

Meta

Field Name	Type	Description
`next`	`null \| string`

Singlesends Get

Returns details about one single send.

Python SDK

await sendgrid.singlesends.get(
    id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "singlesends",
    "action": "get",
    "params": {
        "id": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
`id`	`string`	Yes	The ID of the single send

Records

Field Name	Type	Description
`id`	`string`
`name`	`string`
`status`	`string`
`categories`	`null \| array`
`send_at`	`null \| string`
`send_to`	`null \| object`
`email_config`	`null \| object`
`is_abtest`	`boolean`
`created_at`	`string`
`updated_at`	`string`

Singlesends Search

Search and filter singlesends records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.

Python SDK

await sendgrid.singlesends.search(
    query={"filter": {"eq": {"categories": []}}}
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "singlesends",
    "action": "search",
    "params": {
        "query": {"filter": {"eq": {"categories": []}}}
    }
}'

Parameters

Parameter Name	Type	Required	Description
`query`	`object`	Yes	Filter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, like, fuzzy, keyword, not, and, or
`query.filter`	`object`	No	Filter conditions
`query.sort`	`array`	No	Sort conditions
`limit`	`integer`	No	Maximum results to return (default 1000)
`cursor`	`string`	No	Pagination cursor from previous response's `meta.cursor`
`fields`	`array`	No	Field paths to include in results

Searchable Fields

Field Name	Type	Description
`categories`	`array`	Categories associated with this single send
`created_at`	`string`	When the single send was created
`id`	`string`	Unique single send identifier
`is_abtest`	`boolean`	Whether this is an A/B test
`name`	`string`	Single send name
`send_at`	`string`	Scheduled send time
`status`	`string`	Current status: draft, scheduled, or triggered
`updated_at`	`string`	When the single send was last updated

Field Name	Type	Description
`data`	`array`	List of matching records
`meta`	`object`	Pagination metadata
`meta.has_more`	`boolean`	Whether additional pages are available
`meta.cursor`	`string \| null`	Cursor for next page of results
`meta.took_ms`	`number \| null`	Query execution time in milliseconds
`data[].categories`	`array`	Categories associated with this single send
`data[].created_at`	`string`	When the single send was created
`data[].id`	`string`	Unique single send identifier
`data[].is_abtest`	`boolean`	Whether this is an A/B test
`data[].name`	`string`	Single send name
`data[].send_at`	`string`	Scheduled send time
`data[].status`	`string`	Current status: draft, scheduled, or triggered
`data[].updated_at`	`string`	When the single send was last updated

Templates

Templates List

Returns paged transactional templates (legacy and dynamic).

Python SDK

await sendgrid.templates.list()

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "templates",
    "action": "list"
}'

Parameters

Parameter Name	Type	Required	Description
`generations`	`string`	No	Template generations to return
`page_size`	`integer`	No	Number of templates per page

Records

Field Name	Type	Description
`id`	`string`
`name`	`string`
`generation`	`string`
`updated_at`	`null \| string`
`versions`	`null \| array`

Templates Get

Returns a single transactional template.

Python SDK

await sendgrid.templates.get(
    template_id="<str>"
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "templates",
    "action": "get",
    "params": {
        "template_id": "<str>"
    }
}'

Parameters

Parameter Name	Type	Required	Description
`template_id`	`string`	Yes	The ID of the template

Records

Field Name	Type	Description
`id`	`string`
`name`	`string`
`generation`	`string`
`updated_at`	`null \| string`
`versions`	`null \| array`

Templates Search

Search and filter templates records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.

Python SDK

await sendgrid.templates.search(
    query={"filter": {"eq": {"generation": "<str>"}}}
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "templates",
    "action": "search",
    "params": {
        "query": {"filter": {"eq": {"generation": "<str>"}}}
    }
}'

Parameters

Parameter Name	Type	Required	Description
`query`	`object`	Yes	Filter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, like, fuzzy, keyword, not, and, or
`query.filter`	`object`	No	Filter conditions
`query.sort`	`array`	No	Sort conditions
`limit`	`integer`	No	Maximum results to return (default 1000)
`cursor`	`string`	No	Pagination cursor from previous response's `meta.cursor`
`fields`	`array`	No	Field paths to include in results

Searchable Fields

Field Name	Type	Description
`generation`	`string`	Template generation (legacy or dynamic)
`id`	`string`	Unique template identifier
`name`	`string`	Template name
`updated_at`	`string`	When the template was last updated
`versions`	`array`	Template versions

Field Name	Type	Description
`data`	`array`	List of matching records
`meta`	`object`	Pagination metadata
`meta.has_more`	`boolean`	Whether additional pages are available
`meta.cursor`	`string \| null`	Cursor for next page of results
`meta.took_ms`	`number \| null`	Query execution time in milliseconds
`data[].generation`	`string`	Template generation (legacy or dynamic)
`data[].id`	`string`	Unique template identifier
`data[].name`	`string`	Template name
`data[].updated_at`	`string`	When the template was last updated
`data[].versions`	`array`	Template versions

Singlesend Stats

Singlesend Stats List

Returns stats for all single sends.

Python SDK

await sendgrid.singlesend_stats.list()

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "singlesend_stats",
    "action": "list"
}'

Parameters

Parameter Name	Type	Required	Description
`page_size`	`integer`	No	Maximum number of stats to return per page

Records

Field Name	Type	Description
`id`	`string`
`ab_phase`	`null \| string`
`ab_variation`	`null \| string`
`aggregation`	`null \| string`
`stats`	`null \| object`

Meta

Field Name	Type	Description
`next`	`null \| string`

Singlesend Stats Search

Search and filter singlesend stats records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.

Python SDK

await sendgrid.singlesend_stats.search(
    query={"filter": {"eq": {"ab_phase": "<str>"}}}
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "singlesend_stats",
    "action": "search",
    "params": {
        "query": {"filter": {"eq": {"ab_phase": "<str>"}}}
    }
}'

Parameters

Parameter Name	Type	Required	Description
`query`	`object`	Yes	Filter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, like, fuzzy, keyword, not, and, or
`query.filter`	`object`	No	Filter conditions
`query.sort`	`array`	No	Sort conditions
`limit`	`integer`	No	Maximum results to return (default 1000)
`cursor`	`string`	No	Pagination cursor from previous response's `meta.cursor`
`fields`	`array`	No	Field paths to include in results

Searchable Fields

Field Name	Type	Description
`ab_phase`	`string`	The A/B test phase
`ab_variation`	`string`	The A/B test variation
`aggregation`	`string`	The aggregation type
`id`	`string`	The single send ID
`stats`	`object`	Email statistics for the single send

Field Name	Type	Description
`data`	`array`	List of matching records
`meta`	`object`	Pagination metadata
`meta.has_more`	`boolean`	Whether additional pages are available
`meta.cursor`	`string \| null`	Cursor for next page of results
`meta.took_ms`	`number \| null`	Query execution time in milliseconds
`data[].ab_phase`	`string`	The A/B test phase
`data[].ab_variation`	`string`	The A/B test variation
`data[].aggregation`	`string`	The aggregation type
`data[].id`	`string`	The single send ID
`data[].stats`	`object`	Email statistics for the single send

Bounces

Bounces List

Returns all bounced email records.

Python SDK

await sendgrid.bounces.list()

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "bounces",
    "action": "list"
}'

Parameters

Parameter Name	Type	Required	Description
`limit`	`integer`	No	Number of records to return
`offset`	`integer`	No	Number of records to skip for pagination

Records

Field Name	Type	Description
`created`	`integer`
`email`	`string`
`reason`	`string`
`status`	`string`

Bounces Search

Search and filter bounces records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.

Python SDK

await sendgrid.bounces.search(
    query={"filter": {"eq": {"created": 0}}}
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "bounces",
    "action": "search",
    "params": {
        "query": {"filter": {"eq": {"created": 0}}}
    }
}'

Parameters

Parameter Name	Type	Required	Description
`query`	`object`	Yes	Filter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, like, fuzzy, keyword, not, and, or
`query.filter`	`object`	No	Filter conditions
`query.sort`	`array`	No	Sort conditions
`limit`	`integer`	No	Maximum results to return (default 1000)
`cursor`	`string`	No	Pagination cursor from previous response's `meta.cursor`
`fields`	`array`	No	Field paths to include in results

Searchable Fields

Field Name	Type	Description
`created`	`integer`	Unix timestamp when the bounce occurred
`email`	`string`	The email address that bounced
`reason`	`string`	The reason for the bounce
`status`	`string`	The enhanced status code for the bounce

Field Name	Type	Description
`data`	`array`	List of matching records
`meta`	`object`	Pagination metadata
`meta.has_more`	`boolean`	Whether additional pages are available
`meta.cursor`	`string \| null`	Cursor for next page of results
`meta.took_ms`	`number \| null`	Query execution time in milliseconds
`data[].created`	`integer`	Unix timestamp when the bounce occurred
`data[].email`	`string`	The email address that bounced
`data[].reason`	`string`	The reason for the bounce
`data[].status`	`string`	The enhanced status code for the bounce

Blocks

Blocks List

Returns all blocked email records.

Python SDK

await sendgrid.blocks.list()

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {your_auth_token}' \
--data '{
    "entity": "blocks",
    "action": "list"
}'

Parameters

Parameter Name	Type	Required	Description
`limit`	`integer`	No	Number of records to return
`offset`	`integer`	No	Number of records to skip for pagination

Records

Field Name	Type	Description
`created`	`integer`
`email`	`string`
`reason`	`string`
`status`	`string`

Blocks Search

Search and filter blocks records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.

Python SDK

await sendgrid.blocks.search(
    query={"filter": {"eq": {"created": 0}}}
)

API

curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_connector_id}/execute' \
--header 'Content-Type: application/json' \
--header 'Authoriza

…(truncated)

Sendgrid full reference

File contents

Sendgrid full reference

Supported entities and actions

Contacts

Contacts List

Python SDK

API

Records

Contacts Get

Python SDK

API

Parameters

Records

Contacts Search

Python SDK

API

Parameters

Searchable Fields

Lists

Lists List

Python SDK

API

Parameters

Records

Meta

Lists Get

Python SDK

API

Parameters

Records

Lists Search

Python SDK

API

Parameters

Searchable Fields

Segments

Segments List

Python SDK

API

Records

Segments Get

Python SDK

API

Parameters

Records

Segments Search

Python SDK

API

Parameters

Searchable Fields

Campaigns

Campaigns List

Python SDK

API

Parameters

Records

Meta

Campaigns Search

Python SDK

API

Parameters

Searchable Fields

Singlesends

Singlesends List

Python SDK

API

Parameters

Records

Meta

Singlesends Get

Python SDK

API

Parameters

Records

Singlesends Search

Python SDK

API

Parameters

Searchable Fields