--- title: "Retrieve a partnership" method: GET path: "/v2/partnerships/{unique_identifier}" tags: ["Partnerships"] --- # Retrieve a partnership `GET /v2/partnerships/{unique_identifier}` Retrieves the details of an existing partnership. ## Path parameters - `unique_identifier` string, required ## Response `200` Retrieves the details of an existing partnership. - object - `data` object, required — **Partners** represent users on PartnerStack that will be promoting your company. - `created_at` integer — Immutable Unix timestamp in milliseconds taken at time of creation - `key` string — A unique identifier used to reference the object - `updated_at` integer — Unix timestamp in milliseconds taken at time of last update - `claimed` boolean, nullable — Whether the partnership has been claimed by the partner. - `claimed_at` integer, nullable — When the partnership was claimed by the partner. - `email` string, email — The email of the partner. - `field_data` object, nullable — DEPRECATED 'fields' should be the source of truth - `fields` object[] - `api_name` string — API name of this field to be used on create / update / serialization. Created at time of field creation but can be edited - `description` string, nullable — Description of the field to be displayed to the partner - `external_type` string, nullable — Name that can be used for external systems - `field_key` string — Key of field that is presented - `help_text` string, nullable — The help text that is provided for this field - `hidden` boolean — Whether or not this field is displayed when filling out its attached form - `internal_name` string — Internal name of this field. Created by PartnerStack at time of field creation. Used when referencing field in created objects. Cannot be edited. - `name` string — Name of field that is presented - `options` object — Options to select from if this field is a picklist/checkbox - `placeholder_text` string, nullable — The text of the placeholder that is provided for this field - `position` integer — The position that this field will be displayed in relation to others on the same form (index starts at 0) - `read_only` boolean — Whether or not this field is read only - `required` boolean — Whether or not this field will be required when filling out its attached form - `type` string — The type of field that will be presented (input, picklist, number ect.) - `value` unknown - `first_name` string — The first name of the partner. - `fraud_flagged` boolean, nullable — Whether the partner has been flagged for fraud - `group_join_date` integer, nullable — Timestamp of when the partner joined their current group. This will update if they move groups. - `last_name` string — The last name of the partner. - `manager_email` string, email, nullable — The email of the Partner Manager who you wish to manage this partner. - `manager_name` string, nullable — The name of the Partner Manager who you wish to manage this partner. - `meta` object, nullable — DEPRECATED 'fields' should be the source of truth - `partner_key` string — The `partner_key` you wish to use for this partner. If included, **must** be unique to this partner. For more information on `partner_key` see PartnerStackJS. Note that the partner_key can only consist of letters, numbers, and underscores. - `program_join_date` integer, nullable — Timestamp of when the partner was approved to join the program. This does not change if they move groups. - `tags` string[], nullable - `group` object — **Groups** are a way to segment partners within PartnerStack to selectively distribute access to things such as Campaigns, Marketing Assets, and Rewards - `created_at` integer — Immutable Unix timestamp in milliseconds taken at time of creation - `key` string — A unique identifier used to reference the object - `updated_at` integer — Unix timestamp in milliseconds taken at time of last update - `archived` boolean, nullable — Whether or not this group is still active - `default` boolean — Whether this is the default Group for partners to join - `features` object, nullable — Features that partners within this group have access too - `is_widget_group` boolean, nullable — Whether this is the current referral widget group - `name` string — The name of this Group as presented to partners - `slug` string, nullable — The slugified version of this groups name to be added to routes - `tier` object — **Tiers** enable vendors to provide reward and feature levels. - `key` string, nullable — A unique identifier to identify the tier - `name` string, nullable — Specifies name of the Tier - `address` object, nullable — Partnership's address information. - `city` string, nullable — The city of the residence for this address. - `country` string, nullable — The country of the residence for this address. - `key` string — Key of the Partnership's Address data. - `postal` string, nullable — The postal code for this address. - `primary` boolean, nullable — Is this address the primary residence. - `region` string, nullable — The region of the world for this address. - `state` string, nullable — The state of the residence for this address. - `street` string, nullable — The street address for this address. - `unit` string, nullable — The unit number for the building at this address. - `approved_status` string — The approved status of a partnership. Approved means the partner is approved to be in your program. Pending means that partner's application is pending. Declined means the partner application was declined. - `parent_partnership_key` string, nullable — Key of the partnership that referred this partnership. Only used if 2-Tier Commissions feature is enabled. - `team` object - `key` string, nullable - `name` string, nullable - `network_approval_status` string, nullable - `message` string, required - `status` integer, required ## Other responses - `400` — Bad Request Error - `401` — Unauthorized Error - `403` — Forbidden Error - `404` — Not Found Error - `500` — Internal Server Error --- [API](https://skmtc.dev/partnerstack/apis/partnerstack-api.md) · [All operations](https://skmtc.dev/partnerstack/apis/partnerstack-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/partnerstack/partnerstack-api/revisions/0f35aebe53a9/schema)