Skip to content

Requests and responses

Sparse fieldsets

Ask for only the attributes you use, and for extra ones that are off by default.

Asking for fewer attributes

Add fields[<type>] with a comma-separated list to get only those attributes of that resource type. It applies to resources in data and in included.

http
GET /api/profiles?fields[profile]=email,first_name,location.city

A dotted name keeps one branch of a nested attribute: location.city returns location with only city in it. Each resource keeps its type, id, links and relationships.

Additional fields

Some attributes are left out unless you ask for them, because they take more work to compute. Request them with additional-fields[<type>], for example additional-fields[profile]=subscriptions. A value that is listed in the reference but not built here yet returns 400 saying so.

Endpoints with sparse fieldsets

EndpointResource types
GET /api/accountsfields[account]
GET /api/accounts/{id}fields[account]
GET /api/billing-usagefields[billing-usage]
GET /api/billing-usage/{id}fields[billing-usage]
GET /api/brand-buttonsfields[brand-button]
POST /api/brand-buttonsfields[brand-button]
GET /api/brand-colorsfields[brand-color]
POST /api/brand-colorsfields[brand-color]
GET /api/brand-email-defaultsfields[brand-button]fields[brand-email-default]fields[brand-logo]fields[brand-social-group]
GET /api/brand-logosfields[brand-logo]fields[image]
POST /api/brand-logosfields[brand-logo]
GET /api/brand-social-groupsfields[brand-social-group]
POST /api/brand-social-groupsfields[brand-social-group]
GET /api/brand-buttons/{id}fields[brand-button]
PATCH /api/brand-buttons/{id}fields[brand-button]
GET /api/brand-colors/{id}fields[brand-color]
PATCH /api/brand-colors/{id}fields[brand-color]
GET /api/brand-email-defaults/{id}fields[brand-button]fields[brand-email-default]fields[brand-logo]fields[brand-social-group]
PATCH /api/brand-email-defaults/{id}fields[brand-email-default]
GET /api/brand-logos/{id}fields[brand-logo]fields[image]
PATCH /api/brand-logos/{id}fields[brand-logo]
GET /api/brand-social-groups/{id}fields[brand-social-group]
PATCH /api/brand-social-groups/{id}fields[brand-social-group]
GET /api/brand-voice/{id}fields[brand-voice]
PATCH /api/brand-voice/{id}fields[brand-voice]
POST /api/campaign-audience-clonefields[campaign-audience]
POST /api/campaign-audiencesfields[campaign-audience]
POST /api/campaign-clonefields[campaign]
POST /api/campaign-message-assign-templatefields[campaign-message]
POST /api/campaign-message-clonefields[campaign-message]
POST /api/campaign-message-schedulefields[campaign-message-schedule]
GET /api/campaign-messagesfields[campaign-message]fields[campaign]
POST /api/campaign-messagesfields[campaign-message]
POST /api/campaign-recipient-estimation-jobsfields[campaign-recipient-estimation-job]
POST /api/campaign-send-jobsfields[campaign-send-job]
POST /api/campaign-variationsfields[campaign-variation]
GET /api/campaignsfields[campaign-audience]fields[campaign-message]fields[campaign]fields[tag]
POST /api/campaignsfields[campaign]
GET /api/campaign-audiences/{id}fields[campaign-audience]fields[campaign-message]fields[campaign]
PATCH /api/campaign-audiences/{id}fields[campaign-audience]
GET /api/campaign-messages/{id}fields[campaign-message]fields[campaign-variation]fields[campaign]
PATCH /api/campaign-messages/{id}fields[campaign-message]
GET /api/campaign-recipient-estimation-jobs/{id}fields[campaign-recipient-estimation-job]
GET /api/campaign-recipient-estimations/{id}fields[campaign-recipient-estimation]
GET /api/campaign-send-jobs/{id}fields[campaign-send-job]
GET /api/campaign-variations/{id}fields[campaign-message]fields[campaign-variation]fields[image]fields[translation]
PATCH /api/campaign-variations/{id}fields[campaign-variation]
GET /api/campaigns/{id}fields[campaign-audience]fields[campaign-message]fields[campaign]fields[tag]
PATCH /api/campaigns/{id}fields[campaign]
GET /api/campaign-audiences/{id}/campaignfields[campaign]
GET /api/campaign-audiences/{id}/campaign-messagesfields[campaign-message]
GET /api/campaign-messages/{id}/campaignfields[campaign]
GET /api/campaign-messages/{id}/campaign-audiencefields[campaign-audience]
GET /api/campaign-messages/{id}/campaign-variationsfields[campaign-variation]
GET /api/campaign-messages/{id}/imagefields[image]
GET /api/campaign-messages/{id}/tagsfields[tag]
GET /api/campaign-messages/{id}/templatefields[template]
GET /api/campaign-variations/{id}/campaign-messagefields[campaign-message]
GET /api/campaign-variations/{id}/imagefields[image]
GET /api/campaign-variations/{id}/translationfields[translation]
GET /api/campaigns/{id}/campaign-audiencesfields[campaign-audience]
GET /api/campaigns/{id}/campaign-messagesfields[campaign-message]fields[campaign]
GET /api/campaigns/{id}/tagsfields[tag]
GET /api/catalog-categoriesfields[catalog-category]
POST /api/catalog-categoriesfields[catalog-category]
GET /api/catalog-category-bulk-create-jobsfields[catalog-category-bulk-create-job]
POST /api/catalog-category-bulk-create-jobsfields[catalog-category-bulk-create-job]
GET /api/catalog-category-bulk-delete-jobsfields[catalog-category-bulk-delete-job]
POST /api/catalog-category-bulk-delete-jobsfields[catalog-category-bulk-delete-job]
GET /api/catalog-category-bulk-update-jobsfields[catalog-category-bulk-update-job]
POST /api/catalog-category-bulk-update-jobsfields[catalog-category-bulk-update-job]
GET /api/catalog-item-bulk-create-jobsfields[catalog-item-bulk-create-job]
POST /api/catalog-item-bulk-create-jobsfields[catalog-item-bulk-create-job]
GET /api/catalog-item-bulk-delete-jobsfields[catalog-item-bulk-delete-job]
POST /api/catalog-item-bulk-delete-jobsfields[catalog-item-bulk-delete-job]
GET /api/catalog-item-bulk-update-jobsfields[catalog-item-bulk-update-job]
POST /api/catalog-item-bulk-update-jobsfields[catalog-item-bulk-update-job]
GET /api/catalog-itemsfields[catalog-item]fields[catalog-variant]
POST /api/catalog-itemsfields[catalog-item]
GET /api/catalog-variant-bulk-create-jobsfields[catalog-variant-bulk-create-job]
POST /api/catalog-variant-bulk-create-jobsfields[catalog-variant-bulk-create-job]
GET /api/catalog-variant-bulk-delete-jobsfields[catalog-variant-bulk-delete-job]
POST /api/catalog-variant-bulk-delete-jobsfields[catalog-variant-bulk-delete-job]
GET /api/catalog-variant-bulk-update-jobsfields[catalog-variant-bulk-update-job]
POST /api/catalog-variant-bulk-update-jobsfields[catalog-variant-bulk-update-job]
GET /api/catalog-variantsfields[catalog-variant]
POST /api/catalog-variantsfields[catalog-variant]
GET /api/catalog-categories/{id}fields[catalog-category]
PATCH /api/catalog-categories/{id}fields[catalog-category]
GET /api/catalog-category-bulk-create-jobs/{job_id}fields[catalog-category-bulk-create-job]fields[catalog-category]
GET /api/catalog-category-bulk-delete-jobs/{job_id}fields[catalog-category-bulk-delete-job]
GET /api/catalog-category-bulk-update-jobs/{job_id}fields[catalog-category-bulk-update-job]fields[catalog-category]
GET /api/catalog-item-bulk-create-jobs/{job_id}fields[catalog-item-bulk-create-job]fields[catalog-item]
GET /api/catalog-item-bulk-delete-jobs/{job_id}fields[catalog-item-bulk-delete-job]
GET /api/catalog-item-bulk-update-jobs/{job_id}fields[catalog-item-bulk-update-job]fields[catalog-item]
GET /api/catalog-items/{id}fields[catalog-item]fields[catalog-variant]
PATCH /api/catalog-items/{id}fields[catalog-item]
GET /api/catalog-variant-bulk-create-jobs/{job_id}fields[catalog-variant-bulk-create-job]fields[catalog-variant]
GET /api/catalog-variant-bulk-delete-jobs/{job_id}fields[catalog-variant-bulk-delete-job]
GET /api/catalog-variant-bulk-update-jobs/{job_id}fields[catalog-variant-bulk-update-job]fields[catalog-variant]
GET /api/catalog-variants/{id}fields[catalog-variant]
PATCH /api/catalog-variants/{id}fields[catalog-variant]
GET /api/catalog-categories/{id}/itemsfields[catalog-item]fields[catalog-variant]
GET /api/catalog-items/{id}/categoriesfields[catalog-category]
GET /api/catalog-items/{id}/variantsfields[catalog-variant]
GET /client/geofencesfields[geofence]
GET /client/review-values-reportsfields[review-values-report]
GET /client/reviewsfields[review]
GET /client/ip-allowlists/{id}fields[ip-allowlist]
GET /api/coupon-code-bulk-create-jobsfields[coupon-code-bulk-create-job]
POST /api/coupon-code-bulk-create-jobsfields[coupon-code-bulk-create-job]
GET /api/coupon-codesfields[coupon-code]fields[coupon]
POST /api/coupon-codesfields[coupon-code]
GET /api/couponsfields[coupon]
POST /api/couponsfields[coupon]
GET /api/coupon-code-bulk-create-jobs/{job_id}fields[coupon-code-bulk-create-job]fields[coupon-code]
GET /api/coupon-codes/{id}fields[coupon-code]fields[coupon]
PATCH /api/coupon-codes/{id}fields[coupon-code]
GET /api/coupons/{id}fields[coupon]
PATCH /api/coupons/{id}fields[coupon]
GET /api/coupon-codes/{id}/couponfields[coupon]
GET /api/coupons/{id}/coupon-codesfields[coupon-code]
GET /api/data-sourcesfields[data-source]
POST /api/data-sourcesfields[data-source]
POST /api/object-schemasfields[object-schema]
GET /api/object-typesfields[object-schema]fields[object-type]
POST /api/object-typesfields[object-type]
GET /api/data-sources/{id}fields[data-source]
GET /api/object-records/{id}fields[object-record]
GET /api/object-schemas/{id}fields[object-schema]fields[profile-object-schema]fields[source-mapping]
PATCH /api/object-schemas/{id}fields[object-schema]
GET /api/object-types/{id}fields[object-schema]fields[object-type]fields[profile-object-type]
GET /api/source-mappings/{id}fields[source-mapping]
PATCH /api/source-mappings/{id}fields[source-mapping]
GET /api/object-schemas/{id}/source-mappingfields[source-mapping]
GET /api/object-types/{id}/current-schemafields[object-schema]
GET /api/object-types/{id}/draft-schemafields[object-schema]
GET /api/object-types/{id}/object-ingestion-logsfields[object-ingestion-log]fields[object-record]fields[object-type]
GET /api/object-types/{id}/object-recordsfields[object-record]
GET /api/object-types/{id}/schema-versionsfields[object-schema]
GET /api/eventsfields[attribution]fields[event]fields[metric]fields[profile]
GET /api/events/{id}fields[attribution]fields[event]fields[metric]fields[profile]
GET /api/events/{id}/metricfields[metric]
GET /api/events/{id}/profilefields[profile]
POST /api/flow-actionsfields[flow-action]
GET /api/flowsfields[flow-action]fields[flow]fields[tag]
POST /api/flowsfields[flow]
GET /api/flow-actions/{id}fields[flow-action]fields[flow-message]fields[flow]
PATCH /api/flow-actions/{id}fields[flow-action]
GET /api/flow-messages/{id}fields[flow-action]fields[flow-message]fields[template]
GET /api/flows/{id}fields[flow-action]fields[flow]fields[tag]
PATCH /api/flows/{id}fields[flow]
GET /api/flow-actions/{id}/flowfields[flow]
GET /api/flow-actions/{id}/flow-messagesfields[flow-message]
GET /api/flow-messages/{id}/flow-actionfields[flow-action]
GET /api/flow-messages/{id}/templatefields[template]
GET /api/flows/{id}/flow-actionsfields[flow-action]
GET /api/flows/{id}/tagsfields[tag]
POST /api/form-publish-jobsfields[form-publish-job]
POST /api/form-unpublish-jobsfields[form-unpublish-job]
GET /api/formsfields[form]
POST /api/formsfields[form]
GET /api/form-versions/{id}fields[form-version]fields[form]
GET /api/forms/{id}fields[form]
PATCH /api/forms/{id}fields[form]
GET /api/form-versions/{id}/formfields[form]
GET /api/forms/{id}/form-versionsfields[form-version]
POST /api/image-uploadfields[image]
GET /api/imagesfields[image]
POST /api/imagesfields[image]
GET /api/images/{id}fields[image]
PATCH /api/images/{id}fields[image]
GET /api/listsfields[flow]fields[list]fields[tag]
POST /api/listsfields[list]
GET /api/lists/{id}fields[flow]fields[list]fields[tag]
PATCH /api/lists/{id}fields[list]
GET /api/lists/{id}/flow-triggersfields[flow]
GET /api/lists/{id}/profilesfields[profile]
GET /api/lists/{id}/tagsfields[tag]
GET /api/custom-metricsfields[custom-metric]fields[metric]
POST /api/custom-metricsfields[custom-metric]
GET /api/mapped-metricsfields[custom-metric]fields[mapped-metric]fields[metric]
POST /api/metric-aggregatesfields[metric-aggregate]
GET /api/metricsfields[flow]fields[metric]
GET /api/custom-metrics/{id}fields[custom-metric]fields[metric]
PATCH /api/custom-metrics/{id}fields[custom-metric]
GET /api/mapped-metrics/{id}fields[custom-metric]fields[mapped-metric]fields[metric]
PATCH /api/mapped-metrics/{id}fields[mapped-metric]
GET /api/metric-properties/{id}fields[metric-property]fields[metric]
GET /api/metrics/{id}fields[flow]fields[metric]
GET /api/custom-metrics/{id}/metricsfields[metric]
GET /api/mapped-metrics/{id}/custom-metricfields[custom-metric]
GET /api/mapped-metrics/{id}/metricfields[metric]
GET /api/metric-properties/{id}/metricfields[metric]
GET /api/metrics/{id}/flow-triggersfields[flow]
GET /api/metrics/{id}/metric-propertiesfields[metric-property]
GET /api/profile-bulk-import-jobsfields[profile-bulk-import-job]
POST /api/profile-bulk-import-jobsfields[profile-bulk-import-job]
POST /api/profile-importfields[profile]
POST /api/profile-mergefields[profile]
GET /api/profile-suppression-bulk-create-jobsfields[profile-suppression-bulk-create-job]
POST /api/profile-suppression-bulk-create-jobsfields[profile-suppression-bulk-create-job]
GET /api/profile-suppression-bulk-delete-jobsfields[profile-suppression-bulk-delete-job]
POST /api/profile-suppression-bulk-delete-jobsfields[profile-suppression-bulk-delete-job]
GET /api/profilesfields[conversation]fields[profile]fields[push-token]
POST /api/profilesfields[profile]
GET /api/push-tokensfields[profile]fields[push-token]
GET /api/profile-bulk-import-jobs/{job_id}fields[list]fields[profile-bulk-import-job]
GET /api/profile-suppression-bulk-create-jobs/{job_id}fields[profile-suppression-bulk-create-job]
GET /api/profile-suppression-bulk-delete-jobs/{job_id}fields[profile-suppression-bulk-delete-job]
GET /api/profiles/{id}fields[conversation]fields[list]fields[profile]fields[push-token]fields[segment]
PATCH /api/profiles/{id}fields[profile]
GET /api/push-tokens/{id}fields[profile]fields[push-token]
GET /api/profile-bulk-import-jobs/{id}/import-errorsfields[import-error]
GET /api/profile-bulk-import-jobs/{id}/listsfields[list]
GET /api/profile-bulk-import-jobs/{id}/profilesfields[profile]
GET /api/profiles/{id}/conversationfields[conversation]
GET /api/profiles/{id}/conversationsfields[conversation]
GET /api/profiles/{id}/listsfields[list]
GET /api/profiles/{id}/push-tokensfields[push-token]
GET /api/profiles/{id}/segmentsfields[segment]
GET /api/push-tokens/{id}/profilefields[profile]
POST /api/campaign-values-reportsfields[campaign-values-report]
POST /api/flow-series-reportsfields[flow-series-report]
POST /api/flow-values-reportsfields[flow-values-report]
POST /api/form-series-reportsfields[form-series-report]
POST /api/form-values-reportsfields[form-values-report]
POST /api/segment-series-reportsfields[segment-series-report]
POST /api/segment-values-reportsfields[segment-values-report]
GET /api/reviewsfields[event]fields[review]
GET /api/reviews/{id}fields[event]fields[review]
PATCH /api/reviews/{id}fields[review]
GET /api/segmentsfields[flow]fields[segment]fields[tag]
POST /api/segmentsfields[segment]
GET /api/segments/{id}fields[flow]fields[segment]fields[tag]
PATCH /api/segments/{id}fields[segment]
GET /api/segments/{id}/flow-triggersfields[flow]
GET /api/segments/{id}/profilesfields[profile]
GET /api/segments/{id}/tagsfields[tag]
GET /api/tag-groupsfields[tag-group]
POST /api/tag-groupsfields[tag-group]
GET /api/tagsfields[tag-group]fields[tag]
POST /api/tagsfields[tag]
GET /api/tag-groups/{id}fields[tag-group]
GET /api/tags/{id}fields[tag-group]fields[tag]
GET /api/tag-groups/{id}/tagsfields[tag]
GET /api/tags/{id}/tag-groupfields[tag-group]
POST /api/template-clonefields[template]
GET /api/template-conversion-jobsfields[template-conversion-job]
POST /api/template-conversion-jobsfields[template-conversion-job]
POST /api/template-preview-send-jobsfields[template-preview-send-job]
POST /api/template-renderfields[template]
GET /api/template-universal-contentfields[template-universal-content]
POST /api/template-universal-contentfields[template-universal-content]
POST /api/template-universal-content-clonefields[template-universal-content]
GET /api/templatesfields[template]
POST /api/templatesfields[template]
GET /api/template-conversion-jobs/{id}fields[template-conversion-job]
GET /api/template-universal-content/{id}fields[template-universal-content]
PATCH /api/template-universal-content/{id}fields[template-universal-content]
GET /api/templates/{id}fields[template]
PATCH /api/templates/{id}fields[template]
POST /api/text-messaging-configurationsfields[text-messaging-configuration]
POST /api/text-messaging-sender-registrationsfields[text-messaging-sender-registration]fields[text-messaging-sender]
GET /api/text-messaging-sendersfields[text-messaging-sender-registration]fields[text-messaging-sender]
POST /api/text-messaging-sendersfields[text-messaging-sender-registration]fields[text-messaging-sender]
GET /api/text-messaging-configurations/{id}fields[text-messaging-configuration]
GET /api/text-messaging-sender-registrations/{id}fields[text-messaging-sender-registration]fields[text-messaging-sender]
GET /api/text-messaging-senders/{id}fields[text-messaging-sender-registration]fields[text-messaging-sender]
GET /api/text-messaging-senders/{id}/text-messaging-sender-registrationfields[text-messaging-sender-registration]
GET /api/tracking-settingsfields[tracking-setting]
GET /api/tracking-settings/{id}fields[tracking-setting]
PATCH /api/tracking-settings/{id}fields[tracking-setting]
GET /api/translationsfields[campaign-variation]fields[flow-message]fields[template-universal-content]fields[template]fields[translation]
POST /api/translationsfields[translation]
GET /api/translations/{id}fields[campaign-variation]fields[flow-message]fields[template-universal-content]fields[template]fields[translation]
PATCH /api/translations/{id}fields[translation]
GET /api/web-feedsfields[web-feed]
POST /api/web-feedsfields[web-feed]
GET /api/web-feeds/{id}fields[web-feed]
PATCH /api/web-feeds/{id}fields[web-feed]
GET /api/webhook-topicsfields[webhook-topic]
GET /api/webhooksfields[webhook-topic]fields[webhook]
POST /api/webhooksfields[webhook]
GET /api/webhook-topics/{id}fields[webhook-topic]
GET /api/webhooks/{id}fields[webhook-topic]fields[webhook]
PATCH /api/webhooks/{id}fields[webhook]