> ## Documentation Index
> Fetch the complete documentation index at: https://sendcloud.dev/llms.txt
> Use this file to discover all available pages before exploring further.
# Retrieve a sender address
> Retrieve information about a specific sender address saved to your account.
OAuth2 scopes required: `read:parcel`. See [Scopes for OAuth apps](/api/v3/scopes).
**API v2 is entering maintenance mode.** New users should start with API v3 to access our latest features and improved performance. Already using v2? Don't worry, your current integration remains fully functional. Read more about [maintenance mode](/docs/getting-started/api-version-guide), or check out the [migration guide for API v3](/docs/getting-started/migration-guidelines-for-api-v3).
A sender address `id` for use in this endpoint can be obtained from the [Retrieve a list of sender addresses](/api/v2/sender-addresses/retrieve-a-list-of-sender-addresses) endpoint.
## OpenAPI
````yaml /.openapi/v2/sender-addresses/openapi.yaml get /user/addresses/sender/{id}
openapi: 3.1.0
info:
title: Sender address
version: 2.0.0
description: >-
Use the Sender Addresses API to retrieve sender addresses saved to your
Sendcloud account. Sender addresses can be used when creating parcels via
the API.
contact:
name: Sendcloud API Support
url: https://www.sendcloud.dev
email: contact@sendcloud.com
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
servers:
- url: https://panel.sendcloud.sc/api/v2
description: Production
security: []
tags:
- name: Sender Address
paths:
/user/addresses/sender/{id}:
parameters:
- schema:
type: integer
example: 1234
name: id
in: path
required: true
description: The sender address unique identifier
get:
tags:
- Sender Address
summary: Retrieve a sender address
description: >-
Retrieve information about a specific sender address saved to your
account.
operationId: sc-public-v2-addresses-get-sender_address_by_id
responses:
'200':
description: Sender address information.
content:
application/json:
schema:
description: ''
type: object
properties:
sender_address:
$ref: '#/components/schemas/address'
examples:
RetrieveSenderAddress:
summary: A single sender address
value:
sender_address:
city: Eindhoven
company_name: Sendcloud
contact_name: John Doe
country: NL
country_state: null,
email: johndoe@sendcloud.com
house_number: '10'
id: 1
postal_box: ''
postal_code: 5611 EM
street: Stadhuisplein
telephone: '+31626262626'
vat_number: NL123456789B01
eori_number: NL123456789
brand_id: 2
label: Sample label
signature_full_name: John Doe
signature_initials: JD
'404':
description: Sender address not found
content:
application/json:
schema:
description: ''
type: object
properties:
error:
type: object
required:
- code
- request
- message
properties:
code:
type: integer
request:
type: string
minLength: 1
message:
type: string
minLength: 1
required:
- error
examples:
NotFound:
summary: Not Found
value:
error:
code: 404
request: api/v2/user/addresses/sender/12312312312
message: No sender address matches the given query.
security:
- HTTPBasicAuth: []
- OAuth2ClientCreds:
- read:parcel
components:
schemas:
address:
title: Address Object
type: object
description: A Sendcloud address object
properties:
city:
type: string
maxLength: 30
company_name:
type: string
maxLength: 50
contact_name:
type: string
maxLength: 50
country:
type: string
example: NL
maxLength: 2
country_state:
type: string
nullable: true
maxLength: 10
email:
type: string
maxLength: 254
format: email
house_number:
type: string
maxLength: 20
id:
type: integer
postal_box:
type: string
maxLength: 12
postal_code:
type: string
maxLength: 12
street:
type: string
maxLength: 75
telephone:
type: string
maxLength: 20
vat_number:
type: string
maxLength: 20
eori_number:
type: string
maxLength: 18
brand_id:
type: integer
label:
type: string
maxLength: 30
description: Label of the sender address.
signature_full_name:
type: string
description: Full name that is used for the signature of this sender address.
signature_initials:
type: string
description: Initials that are used for the signature of this sender address.
securitySchemes:
HTTPBasicAuth:
type: http
description: >-
Basic Authentication using API key and secrets is currently the main
authentication mechanism.
scheme: basic
OAuth2ClientCreds:
type: oauth2
description: >-
OAuth2 is a standardized protocol for authorization that allows users to
share their private resources stored on one site with another site
without having to provide their credentials. OAuth2 Client Credentials
Grant workflow. This workflow is typically used for server-to-server
interactions that require authorization to access specific resources.
flows:
clientCredentials:
tokenUrl: https://account.sendcloud.com/oauth2/token/
scopes:
read:analytics: View your shipping analytics
read:audit-log: View your account's audit log
read:brand: View your brands
write:brand: Manage your brands
write:carrier: Configure carriers and contracts
read:checkout: View your dynamic checkout configurations and templates
read:event-subscription: View your event subscriptions
write:event-subscription: Create and manage your event subscriptions
read:integration: View your integrations
write:integration: Connect and manage integrations
read:invoice: View your invoices
read:notification: View your notifications
write:notification: Manage your notifications
read:operational-settings: >-
View your warehouses, shipping lanes, and other operational
settings
write:operational-settings: >-
Manage your warehouses, shipping lanes, and other operational
settings
read:order: View your orders
write:order: Import and process your orders
read:organization: View organization settings
write:organization: Change organization settings
read:parcel: View your shipments and their tracking status
write:parcel: Create, announce, and cancel shipments
read:pickup: View carrier pickups and the options available for scheduling them
write:pickup: Schedule and manage carrier pickups
read:price: View shipping prices
write:product: Manage your product catalog
read:return: View your returns
write:return: Create and manage returns
read:return-settings: View your return settings
write:return-settings: Configure your return settings
read:service-point: View carrier service points
read:shipping-method: View shipping methods, products and prices
read:shipping-rule: View your shipping rules
write:shipping-rule: Create and manage shipping rules
read:support-ticket: View your support tickets
write:support-ticket: Manage your support tickets
read:tracking-message: View your tracking notifications
write:tracking-message: Manage your tracking notifications
read:tracking-page: View your tracking page
write:tracking-page: Customize your tracking page
read:user: Read your basic account information
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.