Sign in
integrations

Get integration metadata

Get integration metadata by ID. Note: If you're interested in joining the beta, please reach out to your Pinterest account manager.

get/integrations/{id}

Path parameters

idstring required

Integration record ID.

Response

The request has succeeded.

additional_id_1string nullable
connected_advertiser_idstring nullable
connected_lba_idstring nullable
connected_merchant_idstring nullable
connected_tag_idstring nullable
connected_user_idstring
created_timeinteger
external_business_idstring nullable
idstring required
partner_access_tokenstring nullable
partner_access_token_expiryinteger nullable
partner_metadatastring nullable
partner_primary_emailstring nullable
partner_refresh_tokenstring nullable
partner_refresh_token_expiryinteger nullable
scopesstring nullable
updated_timeinteger

Example response

{
  "id": "7329123456789012345",
  "external_business_id": "1234567890",
  "connected_merchant_id": "1234567890123",
  "connected_user_id": "123456789012345678",
  "connected_advertiser_id": "123456789012",
  "connected_lba_id": "871234567890123456",
  "connected_tag_id": "2412345678901",
  "partner_access_token": "ABCLUOJS5XDMWDE",
  "partner_refresh_token": "ABCLUOJS5XDMWDE",
  "partner_primary_email": "partner@server.com",
  "partner_access_token_expiry": 1621350033000,
  "partner_refresh_token_expiry": 1621350033000,
  "scopes": "accounts:read",
  "partner_metadata": "",
  "additional_id_1": "123456",
  "created_time": 1621350033000,
  "updated_time": 1621350033000
}

Changes

Changed in 2 of the 29 revisions of this API.211

  • v5b698c180678a210See the full diff
    • ▲

      added the pattern ^\d+$ to the path request parameter id

      request-parameter-pattern-added

    • ▲

      the id response's property type/format changed from string/ to / for status 200

      response-property-type-changed

    • ○

      added the non-success response with the status 400

      response-non-success-status-added

    • ○

      added the non-success response with the status 401

      response-non-success-status-added

    • ○

      added the non-success response with the status 403

      response-non-success-status-added

    • ○

      added the non-success response with the status 429

      response-non-success-status-added

    • ○

      the response optional property connected_advertiser_id became not read-only for the status 200

      response-optional-property-became-not-read-only

    • ○

      the response optional property connected_user_id became not read-only for the status 200

      response-optional-property-became-not-read-only

    • ○

      the response optional property id became read-only for the status 200

      response-optional-property-became-read-only

    • ○

      added Pinterest.Lib.IntegerFormatType to the id response property allOf list for the response status 200

      response-property-all-of-added

    • ○

      the response property id became required for the status 200

      response-property-became-required

    • ○

      the id response's property pattern ^\d+$ was removed for the status 200

      response-property-pattern-removed

    This revision also has 182 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v552586a2747711See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog