Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Page Properties
idapi_docs_client_email_addresses
NameClients / Email Addresses / Index
DescriptionIndex of List Email Addresses for a specified Client
TypeGET
URL/v9/clients/:client_id/email_addresses
Credential TypeAPI
Supports PaginationYes

Long Description

Index of List Email Addresses for a specified Client

Parameters

Required
Name
Description
Value Type
Presence
LocationConditionals
labelArbitrary description for the email address. Must be an exact match.StringOptionalQueryNo
addressEmail address. Must be an exact match.StringOptionalQueryNo
created_atCreation timestampDate (ISO_8601)OptionalQueryYes
updated_atLast updated timestampDate (ISO_8601)OptionalQueryYes

 

Examples

RequestResponse
GET /v9/clients/12345/email_addresses 
Code Block
themeConfluence
languageruby
Paste in Request Code
Code Block
themeConfluence
languageruby
Paste in Response Code