Get account by ID
Use this endpoint to retrieve the details of a specific Account by its identifier. Use this when you have an Account ID and need to confirm its name, Company membership, or timestamps.
Required fields
accountId- the Account identifier, passed as a path parameter (alphanumeric)
Optional parameters
companyIdquery parameter - Company ID (when not inferable from the API key context)Request-Sourceheader - source of the request
Please note
- Returns
404(404_PBLC_001) if no Account exists for the suppliedaccountId, or if it’s not accessible to the calling API key.
Permissions
- Requires:
accounts:read
Authorizations
Company Level Authentication
Company level authentication provides access to all resources under your company, including accounts, campaigns, gifts, and recipients.
Getting Your API Key
- Create an API Key: Use the
POST /v2/authentication/apiKeysendpoint to generate a new API key - Set Expiration: Choose from 30, 60, 90, or 180 days (default: 90 days)
- Optional mTLS: Enable mutual TLS for enhanced security
- Name Your Key: Provide a descriptive name for easy identification
Using Your API Key
Include your API key in the X-Api-Key header for every request:
X-Api-Key: YOUR_24_CHARACTER_API_KEYAPI Key Management
- Maximum Keys: Up to 3 active API keys per company
- Rotation: Delete old keys before creating new ones when at the limit
- Security: Keys are hashed and cannot be retrieved after creation
Enhanced Security (mTLS)
For production environments, enable mutual TLS authentication:
- Set
enforceMtls: truewhen creating the API key - Contact support to obtain your client certificates
- Use the mTLS endpoint:
https://mtls-api.snappy.com/public-api
Headers
Source of the request
api_native, api_zapier, api_salesforce, api_ftp, api_make "api_native"
Path Parameters
The id of the account
^[A-Za-z0-9]+$"xyz12345"
Query Parameters
Company ID
^[A-Za-z0-9]{8,}$"12345678"
Response
Ok
Account details.
The id of the account.
"a12bcd34"
The name of the account.
"Snappy"
Date Format: YYYY-MM-DDThh:mm:ss.sZ.
"2022-12-06T09:50:38.536Z"
Date Format: YYYY-MM-DDThh:mm:ss.sZ.
"2022-12-06T09:50:38.536Z"
The id of the company.
"A1b2C3d4"