Skip to content

Profiles API

Get a profile

GEThttps://email.growthdept.ai/api/profiles/{id}

One profile by id. An id that was merged into another profile returns the surviving profile.

Ask for subscriptions, predictive_analytics, hashed_email and hashed_phone_number with additional-fields[profile]; they are left out unless you do.

Rate limits

Burst: 75/s

Steady: 750/m

Tier L. See rate limits for how requests are counted.

Scopes

profiles:read

Operation id

get_profile The same operation as in Klaviyo's API. OpenAPI document

Path parameters

stringrequired

Query parameters

array of strings

Attributes left out unless asked for.

Additional fields guide

Pick values to add them to the request:

array of strings

Attributes of conversation resources to return.

Sparse fieldsets guide

Pick values to add them to the request:

array of strings

Attributes of list resources to return.

Sparse fieldsets guide

Pick values to add them to the request:

array of strings

Attributes of profile resources to return.

Sparse fieldsets guide

Pick values to add them to the request:

array of strings

Attributes of push-token resources to return.

Sparse fieldsets guide

Pick values to add them to the request:

array of strings

Attributes of segment resources to return.

Sparse fieldsets guide

Pick values to add them to the request:

array of strings

Related resources to side-load.

Includes guide

Pick values to add them to the request:

Headers

stringrequireddefault 2026-10-15

API revision, YYYY-MM-DD. This server implements 2026-10-15.

Revisions guide

Responses

200Success

Response body

object

  • dataobjectrequired

    data: 5 fields
    • typestringrequired

      profile
    • attributesobjectrequired

      attributes: 18 fields
      • subscriptionsobjectcan be null

        subscriptions: 4 fields
        • emailobjectcan be null

          email: 3 fields
          • marketingobjectcan be null

            marketing: 10 fields
            • can_receive_email_marketingbooleanrequired

            • consentstringrequired

            • consent_timestampstring (date-time)can be null

            • last_updatedstring (date-time)can be null

            • methodstringcan be null

            • method_detailstringcan be null

            • custom_method_detailstringcan be null

            • double_optinbooleancan be null

            • suppressionarray of objectscan be null

              suppression: 2 fields
              • reasonstringrequired

                HARD_BOUNCEINVALID_EMAILSPAM_COMPLAINTUNSUBSCRIBEUSER_SUPPRESSED
              • timestampstring (date-time)required

            • list_suppressionsarray of objectscan be null

              list_suppressions: 3 fields
              • list_idstringrequired

              • reasonstringrequired

              • timestampstring (date-time)required

          • open_trackingobjectcan be null

            open_tracking: 7 fields
            • consentstringrequired

            • consent_timestampstring (date-time)can be null

            • last_updatedstring (date-time)can be null

            • created_timestampstring (date-time)can be null

            • metadataobjectcan be null

            • can_receivebooleanrequired

            • valid_untilstring (date-time)can be null

          • click_trackingobjectcan be null

            click_tracking: 7 fields
            • consentstringrequired

            • consent_timestampstring (date-time)can be null

            • last_updatedstring (date-time)can be null

            • created_timestampstring (date-time)can be null

            • metadataobjectcan be null

            • can_receivebooleanrequired

            • valid_untilstring (date-time)can be null

        • smsobjectcan be null

          sms: 2 fields
          • marketingobjectcan be null

            marketing: 6 fields
            • can_receive_sms_marketingbooleanrequired

            • consentstringrequired

            • consent_timestampstring (date-time)can be null

            • methodstringcan be null

            • method_detailstringcan be null

            • last_updatedstring (date-time)can be null

          • transactionalobjectcan be null

            transactional: 6 fields
            • can_receive_sms_transactionalbooleanrequired

            • consentstringrequired

            • consent_timestampstring (date-time)can be null

            • methodstringcan be null

            • method_detailstringcan be null

            • last_updatedstring (date-time)can be null

        • mobile_pushobjectcan be null

          mobile_push: 1 field
          • marketingobjectcan be null

            marketing: 3 fields
            • can_receive_push_marketingbooleanrequired

            • consentstringrequired

            • consent_timestampstring (date-time)can be null

        • whatsappobjectcan be null

          whatsapp: 3 fields
          • marketingobjectcan be null

            marketing: 8 fields
            • consentstringrequired

            • consent_timestampstring (date-time)can be null

            • last_updatedstring (date-time)can be null

            • created_timestampstring (date-time)can be null

            • metadataobjectcan be null

            • can_receivebooleanrequired

            • valid_untilstring (date-time)can be null

            • phone_numberstringcan be null

          • transactionalobjectcan be null

            transactional: 8 fields
            • consentstringrequired

            • consent_timestampstring (date-time)can be null

            • last_updatedstring (date-time)can be null

            • created_timestampstring (date-time)can be null

            • metadataobjectcan be null

            • can_receivebooleanrequired

            • valid_untilstring (date-time)can be null

            • phone_numberstringcan be null

          • conversationalobjectcan be null

            conversational: 8 fields
            • consentstringrequired

            • consent_timestampstring (date-time)can be null

            • last_updatedstring (date-time)can be null

            • created_timestampstring (date-time)can be null

            • metadataobjectcan be null

            • can_receivebooleanrequired

            • valid_untilstring (date-time)can be null

            • phone_numberstringcan be null

      • predictive_analyticsobjectcan be null

        predictive_analytics: 10 fields
        • historic_clvnumbercan be null

        • predicted_clvnumbercan be null

        • total_clvnumbercan be null

        • historic_number_of_ordersnumbercan be null

        • predicted_number_of_ordersnumbercan be null

        • average_days_between_ordersnumbercan be null

        • average_order_valuenumbercan be null

        • churn_probabilitynumbercan be null

        • expected_date_of_next_orderstring (date-time)can be null

        • ranked_channel_affinityarray of stringscan be null

      • hashed_emailstringcan be null

      • hashed_phone_numberstringcan be null

      • emailstringcan be null

      • phone_numberstringcan be null

      • external_idstringcan be null

      • first_namestringcan be null

      • last_namestringcan be null

      • organizationstringcan be null

      • localestringcan be null

      • titlestringcan be null

      • imagestringcan be null

      • createdstring (date-time)can be null

      • updatedstring (date-time)can be null

      • last_event_datestring (date-time)can be null

      • locationobjectcan be null

        location: 10 fields
        • address1stringcan be null

        • address2stringcan be null

        • citystringcan be null

        • countrystringcan be null

        • latitudeone ofcan be null

          One option: string

          No fields.

          One option: number

          No fields.

        • longitudeone ofcan be null

          One option: string

          No fields.

          One option: number

          No fields.

        • regionstringcan be null

        • zipstringcan be null

        • timezonestringcan be null

        • ipstringcan be null

      • propertiesobjectcan be null

    • idstringcan be null

    • relationshipsobject

      relationships: 4 fields
      • listsobject

        lists: 2 fields
        • dataarray of objects

          data: 2 fields
          • typestringrequired

            list
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

      • segmentsobject

        segments: 2 fields
        • dataarray of objects

          data: 2 fields
          • typestringrequired

            segment
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

      • push-tokensobject

        push-tokens: 2 fields
        • dataarray of objects

          data: 2 fields
          • typestringrequired

            push-token
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

      • conversationsobject

        conversations: 2 fields
        • dataarray of objects

          data: 2 fields
          • typestringrequired

            conversation
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

    • linksobjectrequired

      links: 1 field
      • selfstring (uri)required

  • includedarray of objects

    One option: ListResponseObjectResource
    • typestringrequired

      list
    • idstringrequired

    • attributesobjectrequired

      attributes: 4 fields
      • namestringcan be null

      • createdstring (date-time)can be null

      • updatedstring (date-time)can be null

      • opt_in_processstringcan be null

        double_opt_insingle_opt_in
    • relationshipsobject

      relationships: 3 fields
      • profilesobject

        profiles: 2 fields
        • dataarray of objects

          data: 2 fields
          • typestringrequired

            profile
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

      • tagsobject

        tags: 2 fields
        • dataarray of objects

          data: 2 fields
          • typestringrequired

            tag
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

      • flow-triggersobject

        flow-triggers: 2 fields
        • dataarray of objects

          data: 2 fields
          • typestringrequired

            flow
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

    • linksobjectrequired

      links: 1 field
      • selfstring (uri)required

    One option: SegmentResponseObjectResource
    • typestringrequired

      segment
    • idstringrequired

    • attributesobjectrequired

      attributes: 7 fields
      • namestringcan be null

      • definitionobjectcan be null

        definition: 1 field
        • condition_groupsarray of objectsrequired

          condition_groups: 1 field
          • conditionsarray of objectsrequired

            One option: ProfileHasGroupMembershipCondition
            • typestringrequired

              profile-group-membership
            • is_memberbooleanrequired

              true
            • group_idsarray of stringsrequired

            • timeframe_filterone ofcan be null

              One option: StaticDateFilter
              • typestringrequired

                date
              • operatorstringrequired

                afterbefore
              • datestring (date-time)required

              One option: StaticDateRangeFilter
              • typestringrequired

                date
              • operatorstringrequired

                between-static
              • startstring (date-time)required

              • endstring (date-time)required

              One option: RelativeDateOperatorBaseRelativeDateFilter
              • typestringrequired

                date
              • operatorstringrequired

                at-leastin-the-lastin-the-next
              • unitstringrequired

                dayhourweek
              • quantityintegerrequired

              One option: RelativeDateRangeFilter
              • typestringrequired

                date
              • operatorstringrequired

                between
              • startintegerrequired

              • endintegerrequired

              • unitstringrequired

                dayhourweek
            One option: ProfileNoGroupMembershipCondition
            • typestringrequired

              profile-group-membership
            • is_memberbooleanrequired

              false
            • group_idsarray of stringsrequired

            One option: SegmentsProfileMetricCondition
            • typestringrequired

              profile-metric
            • metric_idstringrequired

            • measurementstringrequired

              countsum
            • measurement_filterobjectrequired

              measurement_filter: 3 fields
              • typestringrequired

                numeric
              • operatorstringrequired

                equalsgreater-thangreater-than-or-equalless-thanless-than-or-equalnot-equals
              • valueobjectrequired

            • timeframe_filterone ofrequired

              One option: StaticDateFilter
              • typestringrequired

                date
              • operatorstringrequired

                afterbefore
              • datestring (date-time)required

              One option: StaticDateRangeFilter
              • typestringrequired

                date
              • operatorstringrequired

                between-static
              • startstring (date-time)required

              • endstring (date-time)required

              One option: RelativeDateOperatorBaseRelativeDateFilter
              • typestringrequired

                date
              • operatorstringrequired

                at-leastin-the-lastin-the-next
              • unitstringrequired

                dayhourweek
              • quantityintegerrequired

              One option: RelativeAnniversaryDateFilter
              • typestringrequired

                date
              • operatorstringrequired

                anniversary-lastanniversary-next
              • unitstringrequired

                dayhourweek
              • quantityintegerrequired

              One option: RelativeDateRangeFilter
              • typestringrequired

                date
              • operatorstringrequired

                between
              • startintegerrequired

              • endintegerrequired

              • unitstringrequired

                dayhourweek
              One option: AlltimeDateFilter
              • typestringrequired

                date
              • operatorstringrequired

                alltime
            • metric_filtersarray of objectscan be null

              metric_filters: 2 fields
              • propertystringrequired

              • filterobjectrequired

            One option: ProfileMarketingConsentCondition
            • typestringrequired

              profile-marketing-consent
            • consentone ofrequired

              One option: HasEmailMarketingConsent
              • channelstringrequired

                email
              • can_receive_marketingbooleanrequired

                true
              • consent_statusobjectrequired

              One option: NoEmailMarketingConsent
              • channelstringrequired

                email
              • can_receive_marketingbooleanrequired

                false
              • consent_statusobjectrequired

              One option: HasSMSMarketingConsent
              • channelstringrequired

                sms
              • can_receive_marketingbooleanrequired

                true
              • consent_statusobjectrequired

              One option: NoSMSMarketingConsent
              • channelstringrequired

                sms
              • can_receive_marketingbooleanrequired

                false
              • consent_statusobjectrequired

              One option: HasPushMarketingConsent
              • channelstringrequired

                push
              • can_receive_marketingbooleanrequired

                true
              • consent_statusobjectrequired

              One option: NoPushMarketingConsent
              • channelstringrequired

                push
              • can_receive_marketingbooleanrequired

                false
              • consent_statusobjectrequired

            One option: ProfilePostalCodeDistanceCondition
            • typestringrequired

              profile-postal-code-distance
            • country_codestringrequired

            • postal_codestringrequired

            • unitstringrequired

              kilometersmiles
            • filterone ofrequired

              One option: GreaterThanPositiveNumericFilter
              • typestringrequired

                numeric
              • operatorstringrequired

                greater-than
              • valueobjectrequired

              One option: LessThanPositiveNumericFilter
              • typestringrequired

                numeric
              • operatorstringrequired

                less-than
              • valueobjectrequired

            One option: ProfilePropertyCondition
            • typestringrequired

              profile-property
            • propertystringrequired

            • filterone ofrequired

              One option: StringOperatorStringFilter
              • typestringrequired

                string
              • operatorstringrequired

                containsends-withequalsnot-containsnot-ends-withnot-equalsnot-starts-withnregexregexstarts-with
              • valuestringrequiredcan be null

              One option: StringArrayOperatorStringArrayFilter
              • typestringrequired

                string
              • operatorstringrequired

                innot-in
              • valuearray of stringsrequired

              One option: StringPhoneOperatorStringArrayFilter
              • typestringrequired

                string
              • operatorstringrequired

                phone-country-code-inphone-country-code-not-in
              • valuearray of stringsrequired

              One option: NumericOperatorNumericFilter
              • typestringrequired

                numeric
              • operatorstringrequired

                equalsgreater-thangreater-than-or-equalless-thanless-than-or-equalnot-equals
              • valueobjectrequired

              One option: BooleanFilter
              • typestringrequired

                boolean
              • operatorstringrequired

                equals
              • valuebooleanrequired

              One option: StaticDateFilter
              • typestringrequired

                date
              • operatorstringrequired

                afterbefore
              • datestring (date-time)required

              One option: StaticDateRangeFilter
              • typestringrequired

                date
              • operatorstringrequired

                between-static
              • startstring (date-time)required

              • endstring (date-time)required

              One option: RelativeDateOperatorBaseRelativeDateFilter
              • typestringrequired

                date
              • operatorstringrequired

                at-leastin-the-lastin-the-next
              • unitstringrequired

                dayhourweek
              • quantityintegerrequired

              One option: RelativeAnniversaryDateFilter
              • typestringrequired

                date
              • operatorstringrequired

                anniversary-lastanniversary-next
              • unitstringrequired

                dayhourweek
              • quantityintegerrequired

              One option: RelativeDateRangeFilter
              • typestringrequired

                date
              • operatorstringrequired

                between
              • startintegerrequired

              • endintegerrequired

              • unitstringrequired

                dayhourweek
              One option: CalendarDateFilter
              • typestringrequired

                date
              • operatorstringrequired

                calendar-month
              • valueintegerrequired

              One option: AnniversaryDateFilter
              • typestringrequired

                date
              • operatorstringrequired

                anniversaryanniversary-month
              One option: ListContainsOperatorListContainsFilter
              • typestringrequired

                list
              • operatorstringrequired

                containsnot-contains
              • valueobjectrequiredcan be null

              One option: ListLengthFilter
              • typestringrequired

                list
              • operatorstringrequired

                length-equalslength-greater-thanlength-greater-than-or-equallength-less-thanlength-less-than-or-equal
              • valueintegerrequired

              One option: ExistenceOperatorExistenceFilter
              • typestringrequired

                existence
              • operatorstringrequired

                is-setnot-set
            One option: ProfileRegionCondition
            • typestringrequired

              profile-region
            • in_regionbooleanrequired

            • regionstringrequired

              european_unionunited_states
            One option: ProfilePredictiveAnalyticsDateCondition
            • dimensionstringrequired

              expected_date_of_next_purchase
            • filterone ofrequired

              One option: StaticDateFilter
              • typestringrequired

                date
              • operatorstringrequired

                afterbefore
              • datestring (date-time)required

              One option: StaticDateRangeFilter
              • typestringrequired

                date
              • operatorstringrequired

                between-static
              • startstring (date-time)required

              • endstring (date-time)required

              One option: RelativeDateOperatorBaseRelativeDateFilter
              • typestringrequired

                date
              • operatorstringrequired

                at-leastin-the-lastin-the-next
              • unitstringrequired

                dayhourweek
              • quantityintegerrequired

              One option: RelativeAnniversaryDateFilter
              • typestringrequired

                date
              • operatorstringrequired

                anniversary-lastanniversary-next
              • unitstringrequired

                dayhourweek
              • quantityintegerrequired

              One option: RelativeDateRangeFilter
              • typestringrequired

                date
              • operatorstringrequired

                between
              • startintegerrequired

              • endintegerrequired

              • unitstringrequired

                dayhourweek
              One option: CalendarDateFilter
              • typestringrequired

                date
              • operatorstringrequired

                calendar-month
              • valueintegerrequired

              One option: AnniversaryDateFilter
              • typestringrequired

                date
              • operatorstringrequired

                anniversaryanniversary-month
            • typestringrequired

              profile-predictive-analytics
            One option: ProfilePredictiveAnalyticsNumericCondition
            • typestringrequired

              profile-predictive-analytics
            • dimensionstringrequired

              average_days_between_ordersaverage_order_valuechurn_probabilityhistoric_clvhistoric_number_of_orderspredicted_clvpredicted_number_of_orderstotal_clv
            • filterobjectrequired

              filter: 3 fields
              • typestringrequired

                numeric
              • operatorstringrequired

                equalsgreater-thangreater-than-or-equalless-thanless-than-or-equalnot-equals
              • valueobjectrequired

            One option: ProfilePredictiveAnalyticsStringCondition
            • typestringrequired

              profile-predictive-analytics
            • dimensionstringrequired

              predicted_gender
            • filterobjectrequired

              filter: 3 fields
              • typestringrequired

                string
              • operatorobjectrequired

              • valuestringrequired

                likely_femalelikely_maleuncertain
            One option: ProfilePredictiveAnalyticsChannelAffinityPriorityCondition
            • typestringrequired

              profile-predictive-analytics
            • dimensionstringrequired

              channel_affinity
            • measurementstringrequired

              priority
            • predicted_channelstringrequired

              emailpushsmswhatsapp
            • filterobjectrequired

              filter: 3 fields
              • typestringrequired

                numeric
              • operatorstringrequired

                equals
              • valueintegerrequired

            One option: ProfilePredictiveAnalyticsChannelAffinityRankCondition
            • typestringrequired

              profile-predictive-analytics
            • dimensionstringrequired

              channel_affinity
            • measurementstringrequired

              rank
            • predicted_channelstringrequired

              emailpushsmswhatsapp
            • filterobjectrequired

              filter: 3 fields
              • typestringrequired

                string
              • operatorobjectrequired

              • valuestringrequired

                highlowmedium
            One option: ProfileHasCustomObjectCondition
            • typestringrequired

              profile-has-custom-object
            • object_type_idstringrequired

            • object_type_relationship_idstringrequired

            • filterobjectrequired

              filter: 3 fields
              • typestringrequired

                numeric
              • operatorstringrequired

                equalsgreater-thangreater-than-or-equalless-thanless-than-or-equalnot-equals
              • valueintegerrequired

            • filtersarray of objectsrequired

              filters: 2 fields
              • property_idintegerrequired

              • filterobjectrequired

            One option: ProfilePermissionsCondition
            • typestringrequired

              profile-permissions
            • permissionone ofrequired

              One option: ExplicitlyReachable
              • reachable_statusstringrequired

                explicitly_reachable
              • filtersarray of objectsrequired

              One option: ImplicitlyReachable
              • reachable_statusstringrequired

                implicitly_reachable
              One option: ImplicitlyOrExplicitlyReachable
              • reachable_statusstringrequired

                implicitly_or_explicitly_reachable
              One option: ExplicitlyUnreachable
              • reachable_statusstringrequired

                explicitly_unreachable
              • filtersarray of objectsrequired

              One option: ImplicitlyUnreachable
              • reachable_statusstringrequired

                implicitly_unreachable
              One option: ImplicitlyOrExplicitlyUnreachable
              • reachable_statusstringrequired

                implicitly_or_explicitly_unreachable
            • channelstringrequired

              email_click_trackingemail_open_trackingwhatsapp_marketingwhatsapp_transactional
            One option: SegmentsProfileMetricFunnelCondition
            • typestringrequired

              profile-metric-funnel
            • timeframe_filterone ofrequired

              One option: StaticDateRangeFilter
              • typestringrequired

                date
              • operatorstringrequired

                between-static
              • startstring (date-time)required

              • endstring (date-time)required

              One option: RelativeDateRangeFilter
              • typestringrequired

                date
              • operatorstringrequired

                between
              • startintegerrequired

              • endintegerrequired

              • unitstringrequired

                dayhourweek
              One option: RelativeDateOperatorBaseRelativeDateFilter
              • typestringrequired

                date
              • operatorstringrequired

                at-leastin-the-lastin-the-next
              • unitstringrequired

                dayhourweek
              • quantityintegerrequired

            • completion_window_secondsstringcan be null

              DAYS_1DAYS_180DAYS_3DAYS_30DAYS_5DAYS_90HOURS_1WEEKS_1YEARS_1
            • stepsarray of objectsrequired

              steps: 3 fields
              • metric_existsbooleanrequired

              • metric_idstringrequired

              • metric_filtersarray of objectscan be null

      • createdstring (date-time)can be null

      • updatedstring (date-time)can be null

      • is_activebooleanrequired

      • is_processingbooleanrequired

      • is_starredbooleanrequired

    • relationshipsobject

      relationships: 3 fields
      • profilesobject

        profiles: 2 fields
        • dataarray of objects

          data: 2 fields
          • typestringrequired

            profile
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

      • tagsobject

        tags: 2 fields
        • dataarray of objects

          data: 2 fields
          • typestringrequired

            tag
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

      • flow-triggersobject

        flow-triggers: 2 fields
        • dataarray of objects

          data: 2 fields
          • typestringrequired

            flow
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

    • linksobjectrequired

      links: 1 field
      • selfstring (uri)required

    One option: ConversationResponseObjectResource
    • typestringrequired

      conversation
    • idstringrequired

    • attributesobjectrequired

      attributes: 1 field
      • channelstringrequired

        instagramsmswhatsapp
    • relationshipsobject

      relationships: 1 field
      • profileobject

        profile: 2 fields
        • dataobject

          data: 2 fields
          • typestringrequired

            profile
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

    • linksobjectrequired

      links: 1 field
      • selfstring (uri)required

    One option: PushTokenResponseObjectResource
    • typestringrequired

      push-token
    • idstringrequired

    • attributesobjectrequired

      attributes: 8 fields
      • createdstring (date-time)required

      • tokenstringrequired

      • enablement_statusstringrequired

        AUTHORIZEDDENIEDNOT_DETERMINEDPROVISIONALUNAUTHORIZED
      • platformstringrequired

        androidios
      • vendorstringrequired

      • backgroundstringrequired

      • recorded_datestringrequired

      • metadataobjectcan be null

        metadata: 12 fields
        • device_idstringcan be null

        • klaviyo_sdkstringcan be null

          androidflutterflutter_communityreact_nativeswift
        • sdk_versionstringcan be null

        • device_modelstringcan be null

        • os_namestringcan be null

          androidiosipadosmacostvos
        • os_versionstringcan be null

        • manufacturerstringcan be null

        • app_namestringcan be null

        • app_versionstringcan be null

        • app_buildstringcan be null

        • app_idstringcan be null

        • environmentstringcan be null

          debugrelease
    • relationshipsobject

      relationships: 1 field
      • profileobject

        profile: 2 fields
        • dataobject

          data: 2 fields
          • typestringrequired

            profile
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

    • linksobjectrequired

      links: 1 field
      • selfstring (uri)required

  • linksobject

    links: 1 field
    • selfstring (uri)required

  • metaobject

4XXClient error

Response body

object

  • errorsarray of objectsrequired

    errors: 8 fields
    • idstringrequired

    • statusintegerrequired

    • codestringrequired

    • titlestringrequired

    • detailstringrequired

    • sourceobject

      source: 2 fields
      • pointerstring

      • parameterstring

    • linksobject

    • metaobject

See status codes for each code.

5XXServer error

Response body

object

  • errorsarray of objectsrequired

    errors: 8 fields
    • idstringrequired

    • statusintegerrequired

    • codestringrequired

    • titlestringrequired

    • detailstringrequired

    • sourceobject

      source: 2 fields
      • pointerstring

      • parameterstring

    • linksobject

    • metaobject