# Get a single SalesPartner

Can be used for retrieving informations about a single SalesPartner. This could either be your own SalesPartner or if your SalesPartner is a parent an associated child SalesPartner.

Endpoint: GET /sales-partners/{id}
Version: 20260331
Security: X-API-KEY, Authorization

## Path parameters:

  - `id` (string, required)
    ID of the SalesPartner

## Response 200 fields (*/*):

  - `status` (string, required)
    Enum: "SUCCESS", "PENDING", "QUOTA_LIMIT_EXCEED", "NOT_AUTHORIZED", "FORBIDDEN", "BAD_ACCESS_TOKEN", "BAD_PRIVATE_KEY", "BAD_PUBLIC_KEY", "MISSING_PARAMETER", "INVALID_PARAMETER", "WRONG_PARAMETER_TYPE", "CONFLICT", "RESOURCE_LOCKED", "SERVER_ERROR", "ERROR", "NOT_FOUND", "BAD_REQUEST", "USER_ERROR", "PARTIAL_ERROR"

  - `message` (string)
    (optional) Holds further information about the response

  - `warnings` (array)
    (optional) Holds further warnings

  - `response` (object, required)
    The actual response object of the response

  - `response.salesPartner` (object)
    Sales Partner Model

  - `response.salesPartner.id` (integer)
    The uberall sales partner id

  - `response.salesPartner.aggregateInvoicesToParent` (boolean)
    (only used for child SalesPartner) Indicates if the invoice for this SalesPartner should be aggregated to the parent invoice

  - `response.salesPartner.attribution` (object)
    Attribution details of the SalesPartner

  - `response.salesPartner.attribution.name` (string, required)
    Name of the attribution

  - `response.salesPartner.attribution.url` (string, required)
    URL the attribution should point to

  - `response.salesPartner.attribution.id` (integer)

  - `response.salesPartner.attribution.logo` (object)
    Logo details model

  - `response.salesPartner.attribution.logo.url` (string, required)
    Url pointing to the attribution logo

  - `response.salesPartner.attribution.logo.type` (string)
    Type
    Example: "LOGO"

  - `response.salesPartner.attribution.logo.description` (string)
    Description of the logo

  - `response.salesPartner.canSeePrices` (boolean)
    Indicates if the SalesPartner should be allowed to see price information for e.g. product plans

  - `response.salesPartner.emailCustomerSupport` (string)
    Customer support email of the SalesPartner

  - `response.salesPartner.emailProjectLead` (string)
    Project lead email of the SalesPartner

  - `response.salesPartner.forceSso` (boolean)
    If set to true, all users of this SalesPartner will only be allowed to log in our app via the SSO flow. Users cannot be created or updated directly - only via SSO. If set to false and "isSsoActive" is set, users can either log in via normal login or SSO

  - `response.salesPartner.identifier` (string)
    Identifier for SalesPartner, must be unique for child SalesPartner within parent SalesPartner

  - `response.salesPartner.minPasswordLength` (integer)
    Minimum password length

  - `response.salesPartner.name` (string)
    The name

  - `response.salesPartner.phone` (string)
    The phone number

  - `response.salesPartner.preferredLanguage` (string)
    Preferred language of the SalesPartner, for invoice purpose (either 'de' or 'en')

  - `response.salesPartner.pushUrl` (string)
    URL where selected webhook events should be sent to

  - `response.salesPartner.salesPartnerStatus` (string)
    SalesPartner status of the SalesPartner (Be aware: Only sending 'INACTIVE' for child SalesPartner update is allowed)
    Enum: "CREATED", "APPROVED", "DECLINED", "DELETED", "INACTIVE"

  - `response.salesPartner.subscribedWebhookEventTypes` (array)
    List of all event types the SalesPartner want to receive push messages for via webhook functionality, for a list of all possible types use the GET /api/salespartners/subscribable-event-types endpoint
    Enum: "ADMIN_ALERT", "BRAND_DATA_POINT_REPLIED", "BRAND_DATA_POINT_REPLIED_PENDING_APPROVAL", "BRAND_DATA_POINT_REPLY_APPROVE", "BRAND_DATA_POINT_REPLY_REJECT", "BUSINESS_CHAIN_UPDATE", "BUSINESS_CHANGED_SALES_PARTNER", "BUSINESS_COMMENT", "BUSINESS_CREATED", "BUSINESS_CSV_EXPORT", "BUSINESS_DIRECTORY_ACCOUNT", "BUSINESS_DIRECTORY_CONNECT", "BUSINESS_DUPLICATE_CHECK", "BUSINESS_FACEBOOK_PAGE_INVALIDATE", "BUSINESS_INVOICE_CHANGED", "BUSINESS_INVOICE_CREATED", "BUSINESS_INVOICE_CREATED_ANOTHER_BASIC", "BUSINESS_INVOICE_CREATED_ANOTHER_PREMIUM", "BUSINESS_INVOICE_CREATED_FIRST_BASIC", "BUSINESS_INVOICE_CREATED_FIRST_PREMIUM", "BUSINESS_INVOICE_CREATED_RENEWAL", "BUSINESS_INVOICE_CREATED_UPGRADE_BASIC", "BUSINESS_INVOICE_CREATED_UPGRADE_PREMIUM", "BUSINESS_INVOICE_RENEWAL_FAIL", "BUSINESS_INVOICE_RENEWAL_SUCCESS", "BUSINESS_LOCATION_DATA_PULL", "BUSINESS_MIGRATE_LOCATION", "BUSINESS_NEW_CHATS", "BUSINESS_NEW_CONTACT_FORM", "BUSINESS_OLO_IMPORT", "BUSINESS_OLO_SETTINGS_CREATED", "BUSINESS_OLO_SETTINGS_DELETED", "BUSINESS_OLO_SETTINGS_UPDATED", "BUSINESS_PAGE_INVALIDATE", "BUSINESS_PAY_INVOICE", "BUSINESS_PRODUCT_PLAN_CHANGED", "BUSINESS_STATUS_CHANGED", "BUSINESS_TEMPLATE_UPDATE", "BUSINESS_UPDATE_PAGE_SOCIAL_POST", "BUSINESS_UPDATE_PRICE", "DATA_POINT_AUTOMATED_REPLY", "DATA_POINT_REPLIED", "DATA_POINT_REPLIED_PENDING_APPROVAL", "DATA_POINT_REPLY_APPROVE", "DATA_POINT_REPLY_REJECT", "DATA_POINT_SERVICE_NOW_SUBMITTED", "DIRECTORY_BUSINESS_PAGE_DATA_POINT_CHECK", "DIRECTORY_BUSINESS_PAGE_DATA_POINT_INVALID", "DIRECTORY_USER_ACCOUNT_DIRECTORY_CONNECT", "LISTING_AUTOVALIDATION_FAILED", "LISTING_BLACKLIST", "LISTING_CANCEL", "LISTING_DATAPOINT_CHECK", "LISTING_DATAPOINT_INVALID", "LISTING_DELETE", "LISTING_DIRECTORY_CONNECT", "LISTING_DIRECTORY_DUPLICATE_REMOVED", "LISTING_FACEBOOK_PAGE_INVALIDATE", "LISTING_FEED_CREATE", "LISTING_FEED_DUPLICATE_REMOVED", "LISTING_FEED_IN_SYNC_FIELDS", "LISTING_FLAGGED", "LISTING_GOOGLE_PAGE_CREATE", "LISTING_GOOGLE_PAGE_INVALIDATE", "LISTING_GOOGLE_PAGE_UPDATE", "LISTING_INITIATE_OWNERSHIP_TRANSFER", "LISTING_INVITATION_SENT", "LISTING_LINK_CHANGE", "LISTING_MANUAL", "LISTING_NEEDS_REVIEW_DELETED", "LISTING_PAGE_INVALIDATE", "LISTING_PUBLISHER_UPDATE", "LISTING_REMOVAL_STATUS_CHECK", "LISTING_REMOVAL_SUPPRESS", "LISTING_REVIEWED", "LISTING_STATUS_CHANGE", "LISTING_SUGGESTION", "LISTING_SUPPRESS", "LISTING_SUPPRESS_NOT_ALLOWED", "LISTING_SYNC_CHECK", "LISTING_UPDATE", "LISTING_UPDATE_PAGE_SOCIAL_POST", "LISTING_UPDATE_SOCIAL_POST", "LISTING_WAITING_DIRECTORY_ACTION", "LOCATION_BILLING", "LOCATION_BUSINESS_CHANGED", "LOCATION_CHECKOUT", "LOCATION_CHECKOUT_FREE", "LOCATION_CHECKOUT_SALESPARTNER", "LOCATION_CHECKOUT_UPGRADE", "LOCATION_CLEANSING", "LOCATION_CONTRACT_UPDATED", "LOCATION_CREATED", "LOCATION_DUPLICATE_LISTING_CHECK", "LOCATION_DUPLICATE_LISTING_DETECTION", "LOCATION_FEED_CLOSED", "LOCATION_FEED_PROFILE_CHANGED", "LOCATION_GEOCODING_MANUAL", "LOCATION_GOOGLE_RANK_CHECK", "LOCATION_GROUP_CREATED", "LOCATION_GROUP_DELETED", "LOCATION_GROUP_UPDATED", "LOCATION_INVOICE_CHANGED", "LOCATION_LISTING_ADDED", "LOCATION_NEEDS_REVIEW_DELETED", "LOCATION_NEW_CHATS", "LOCATION_NEW_CONTACT_FORM", "LOCATION_NORMALIZATION_STATUS_CHANGED", "LOCATION_OLO_IMPORT", "LOCATION_PARTIAL_UPDATE", "LOCATION_PAY_INVOICE", "LOCATION_PROFILE_CHANGED", "LOCATION_PROFILE_SUGGESTION_DECLINE", "LOCATION_STATUS_CHANGED", "LOCATION_SUBSCRIPTION_CHANGED", "LOCATION_SUGGESTION_CREATED", "LOCATION_SUGGESTION_UPDATED", "LOCATION_SYNC_CHECK", "LOCATION_SYNC_STARTED", "LOCATION_VISIBILITY_INDEX_CHANGED", "PEON_MANUAL_ENQUEUE", "PRODUCT_PLAN_CREATED", "PRODUCT_PLAN_DELETED", "PRODUCT_PLAN_UPDATED", "SALES_PARTNER_APPROVAL", "SALES_PARTNER_CHILDREN_UPDATED", "SALES_PARTNER_CREATED", "SALES_PARTNER_DIRECTORY_BRAND", "SALES_PARTNER_DIRECTORY_CONNECT", "SALES_PARTNER_ENTERPRISE_ONBOARDING", "SALES_PARTNER_INVOICE_CHANGED", "SALES_PARTNER_INVOICE_PAYMENT_INFORMATION_CHANGED", "SALES_PARTNER_ONE_AND_ONE_AUTHENTICATION", "SALES_PARTNER_ONE_AND_ONE_CONTRACT_INFORMATION", "SALES_PARTNER_PASSWORD_RESET", "SALES_PARTNER_PAYMENT_METHOD_RESET", "SALES_PARTNER_PAY_INVOICE", "SALES_PARTNER_REPRESENTATIVE_UPDATE", "SALES_PARTNER_SIGNUP", "SALES_PARTNER_STATUS_CHANGED", "SALES_PARTNER_TYPE_CHANGED", "SALES_PARTNER_UPDATED", "SALES_REPRESENTATIVE_UPDATE", "SEARCH_DATA_RECHECK_LINK_SHARED", "USER_ACTIVATION_EMAIL_SENT", "USER_DASHBOARD_EXPORT_COMPLETE", "USER_DIGEST_EMAIL_SENT", "USER_FINISH_VERIFICATION_GOOGLE_EMAIL_SENT", "USER_INVITATION", "USER_INVITATION_EMAIL_SENT", "USER_INVOICE_INVITATION", "USER_MODIFY_EMAIL_SETTING", "USER_NOTIFICATION_EMAIL_SENT", "USER_PASSWORD_RESET", "USER_PENDING_APPROVAL_REPLY_NOTIFICATION_EMAIL_SENT", "USER_READ_DATA_POINT", "USER_START_VERIFICATION_GOOGLE_EMAIL_SENT", "USER_STATUS_CHANGED", "USER_TIER1_EMAIL_SENT", "USER_TIER2_EMAIL_SENT", "USER_TIER3_EMAIL_SENT", "USER_UNREAD_DATA_POINT", "USER_UNREAD_REVIEW_NOTIFICATION_EMAIL_SENT", "USER_UPDATED", "USER_SOCIAL_POST_PENDING_APPROVAL_EMAIL_SENT", "WIDGET_CONFIG_CREATED", "WIDGET_CONFIG_DELETED", "WIDGET_CONFIG_PUBLISHED", "SOCIAL_POST_PENDING_APPROVAL"

  - `response.salesPartner.whitelistedRedirectUrls` (array)
    Domains that are allowed to be redirected to upon finalizing a directory connect flow

  - `response.salesPartner.currency` (string)
    The currency

  - `response.salesPartner.entity` (string)
    Uberall entity
    Enum: "UBERALL_BV", "UBERALL_CANADA_INC", "UBERALL_FR", "UBERALL_GMBH", "UBERALL_INC", "UBERALL_MF", "UBERALL_UK"

  - `response.salesPartner.isSsoActive` (boolean)
    If set to true this will activate the single sign-on flow for logging into our app. Note that all more details need to be set before it can be used.

  - `response.salesPartner.maxFreeLocations` (integer)
    Max free locations

  - `response.salesPartner.type` (string)
    The type, e.g. STANDARD or CUSTOM

  - `response.salesPartner.whitelabelInformations` (array)
    List of the sales partner's white-label information

  - `response.salesPartner.whitelabelInformations.id` (integer)
    id

  - `response.salesPartner.whitelabelInformations.name` (string)
    Name of white-label information

  - `response.salesPartner.whitelabelInformations.identifier` (string)
    Url path of the white-label information

  - `response.salesPartner.onboardingStatus` (string)
    The onboarding status of the SalesPartner
    Enum: "NOT_STARTED", "IN_PROGRESS", "FINISHED", "ABORTED"

  - `response.salesPartner.locationGroupIds` (array)

  - `response.salesPartner.country` (string)
    The country
    Enum: "AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BQ", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KP", "KR", "XK", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SX", "SK", "SI", "SB", "SO", "ZA", "GS", "SS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "UK", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW"

  - `response.salesPartner.commission` (integer)

  - `response.salesPartner.address` (string)
    Full address field including street, zip and city.

  - `response.salesPartner.contactPerson` (integer)
    The contact person

  - `response.salesPartner.emailAccounting` (string)
    Accounting email of the SalesPartner

  - `response.salesPartner.vatId` (string)

  - `response.salesPartner.parentId` (integer)

  - `response.salesPartner.price` (integer)

  - `response.salesPartner.priceMin` (integer)

## Response 400 fields (application/json):

  - `status` (string, required)
    Enum: same as `status` (19 values)

  - `message` (string)
    (optional) Holds further information about the response

  - `errorCode` (string)
    Enum: "NORMALIZATION_FAILED", "DATA_CORRUPTED", "INVALID_INPUT", "NOT_SYNCABLE", "PAYMENT_FAILED", "FREE_TIER_REACHED", "LIMIT_REACHED", "INACTIVE", "UNKNOWN", "IDENTIFIER_NOT_UNIQUE", "ACCOUNT_WAITING_FOR_AUTO_PAGE_SELECT", "NO_ACCOUNT_CONNECTED", "NO_PAGE_SELECTED", "PAGE_NOT_CREATED", "PAGE_IN_REVIEW", "PAGE_CLAIMED_BY_OTHERS", "OVERLAPPING_SOCIALPOST", "TOO_MANY_REPLIES", "REPLY_TOO_LONG", "DEPRECATED"

  - `response` (object)
    (optional) The actual response object of the response

## Response 401 fields (application/json):

  - `status` (string, required)
    Enum: same as `status` (19 values)

  - `message` (string)
    (optional) Holds further information about the response

  - `errorCode` (string)
    Enum: same as `errorCode` (20 values)

  - `response` (object)
    (optional) The actual response object of the response

## Response 403 fields (application/json):

  - `status` (string, required)
    Enum: same as `status` (19 values)

  - `message` (string)
    (optional) Holds further information about the response

  - `errorCode` (string)
    Enum: same as `errorCode` (20 values)

  - `response` (object)
    (optional) The actual response object of the response

## Response 404 fields (application/json):

  - `status` (string, required)
    Enum: same as `status` (19 values)

  - `message` (string)
    (optional) Holds further information about the response

  - `errorCode` (string)
    Enum: same as `errorCode` (20 values)

  - `response` (object)
    (optional) The actual response object of the response