Newsroom API Documentation
Everything you need to integrate pr.co into your website or app.

Pressrooms
Retrieve a pressroom or it's contents

Supported Formats

json
>>>

GET /v1/pressrooms/:id.json

Retrieve a pressroom

Supported Formats

json

Errors

Code Description
404 Missing

Examples

GET /v1/pressrooms/1009.json
200
{
  "data": {
    "id": 1009,
    "slug": "rosenbaum",
    "permalink": "http://rosenbaum.pr.co",
    "name": "Example Pressroom",
    "description": "This is an example pressroom created using pr.co",
    "country_code": "WW",
    "language": "en",
    "urls": {
      "homepage": "http://pr.co",
      "blog": "http://blog.pr.co",
      "contact": "http://pr.co/support",
      "twitter": null,
      "facebook": "http://facebook.com/prdotco",
      "linkedin": null,
      "media_kit": null,
      "googleplus": null,
      "instagram": null,
      "sitemap": "https://app.pr.co/sitemap-1009-rosenbaum.xml"
    },
    "contact_info": "Get in touch with dennis@pr.co for more information about thie awesome API",
    "logo": {
      "small": "https://d3gvv7thuwd750.cloudfront.net/1009/logo/small-1357034400.png",
      "small_url": "https://d3gvv7thuwd750.cloudfront.net/1009/logo/small-1357034400.png",
      "square_url": "https://d3gvv7thuwd750.cloudfront.net/1009/logo/small_square-1357034400.png",
      "small_square_url": "https://d3gvv7thuwd750.cloudfront.net/1009/logo/tiny_square-1357034400.png",
      "retina_url": null,
      "original_url": "https://d3gvv7thuwd750.cloudfront.net/1009/logo/original-1357034400.png"
    },
    "links": [
      "http://instagram.com/prdotco"
    ],
    "type": "regular",
    "multicountry": false,
    "country": false,
    "css": "<style type=\"text/css\">#wrapper{background-color:#bada55}#wrapper{background-image:url(https://d3gvv7thuwd750.cloudfront.net/1009/background_image/original-1357034400.jpg)}#wrapper{background-repeat:no-repeat}#wrapper a{color:#bada55}#agency_pressroom .client_pressroom:hover{background-color:#bada55;border-color:#bada55}</style>",
    "noindex": false,
    "nofollow": false,
    "twitter_widget_id": null,
    "twitter_embed_code": null,
    "ga_code": null,
    "timezone": "Amsterdam",
    "subscribe_enabled": true,
    "followers_enabled": true,
    "design": {
      "background_image": "https://d3gvv7thuwd750.cloudfront.net/1009/background_image/original-1357034400.jpg",
      "background_color": "#bada55",
      "background_fixed": false,
      "background_repeat": false,
      "link_color": "#bada55",
      "css": "p{background-color: #bada55;}",
      "layout": "classic",
      "javascript": null
    },
    "parent_pressrooms": [],
    "child_pressrooms": [],
    "parent_multicountry_pressroom": null,
    "child_multicountry_pressrooms": null,
    "countries": [],
    "country_codes": [],
    "languages": [
      "en"
    ],
    "show_banner": false,
    "show_media_kit": false,
    "show_media_kit_categories": false,
    "media_kit_categories_tree": null,
    "tag_tree_enabled": false,
    "tag_tree": null,
    "login_enabled": false,
    "language_redirect": false,
    "search_enabled": false,
    "override_pagination": null,
    "split_timeline": null,
    "pr_contacts": [
      {
        "name": "Example PR contact",
        "contact_info": "0612001200 or dennis@pr.co",
        "id": 1005,
        "urls": {
          "twitter": "https://twitter.com/prdotco",
          "skype": "skype:prdotco",
          "avatar": "https://pbs.twimg.com/profile_images/378800000726257713/dea939141435719cd3c8150b94b5879a_bigger.png"
        },
        "usernames": {
          "skype": "prdotco",
          "twitter": "prdotco"
        },
        "avatar": {
          "medium_square": {
            "width": 100,
            "height": 100,
            "url": null
          },
          "large_square": {
            "width": 500,
            "height": 500,
            "url": null
          },
          "original": {
            "width": null,
            "height": null,
            "url": null
          }
        }
      }
    ]
  }
}

Params

Param name Description
id
required

Pressroom id or pressroom domain

Validations:

  • Must be a String
includes
optional

Include attachments. To include featured images use: featured_images.

Validations:

  • Must be a String
>>>

GET /v1/pressrooms/:id/timeline.json

Retrieves the complete timeline for a pressroom

Supported Formats

json

Errors

Code Description
404 Missing

Examples

GET /v1/pressrooms/rosenbaum/timeline
200
{
  "data": [
    {
      "id": 6,
      "pressroom_id": 1009,
      "press_release_id": null,
      "title": "Example clipping",
      "source": "thenextweb.com",
      "url": "http://thenextweb.com/great-article-to-read",
      "release_date": null,
      "shares": {
        "facebook": 10,
        "linkedin": 1000,
        "twitter": 100
      },
      "sizes": {
        "original": {
          "width": null,
          "height": null,
          "url": "https://d3gvv7thuwd750.cloudfront.net/1009/screenshots/screenshot-taken-from-source-url.jpg"
        },
        "thumbnail": {
          "width": 512,
          "height": 384,
          "url": "https://d3gvv7thuwd750.cloudfront.net/1009/screenshots/6-screenshot-taken-from-source-url-thumbnail.jpg"
        }
      },
      "alexa": null,
      "private": false,
      "permalink": "/clippings/6-example-clipping",
      "type": "clipping",
      "show_iframe": true,
      "language": "en"
    },
    {
      "id": 5,
      "pressroom_id": 1009,
      "title": "Test Pressroom",
      "subtitle": null,
      "release_date": null,
      "release_location": null,
      "language": "en",
      "social_media_pitch": null,
      "summary": null,
      "body_html": "<p>Officiis nemo rerum tempora quis dolores iure dolorem aut. Ea dolores id sequi error. Quasi dolorem quas qui perferendis eos ipsa beatae atque. Unde molestiae doloremque labore impedit. Placeat incidunt voluptates laborum quae eaque aut eum. Non in qui quam et quia natus. Non ullam sunt ab consequatur quia nostrum et qui. Ipsum esse earum veniam. Iste omnis assumenda iure aliquid. Odio doloribus cumque voluptas quidem voluptatem quam eum omnis. Magni autem doloremque nemo voluptatem dolore eveniet distinctio. Id rem rerum consequatur. Explicabo perspiciatis fuga sequi voluptas corrupti aut. Pariatur maiores numquam nostrum occaecati. Ut aut dolorum eum neque. Ut voluptatibus nulla maiores est rem pariatur. Architecto inventore autem quisquam magnam ipsum cum eos vitae.</p>",
      "permalink": "/5-test-pressroom",
      "type": "press_release",
      "state": "published",
      "short_link": "https://pr.co/p/",
      "pdf": null,
      "show_in_timeline": true,
      "content_as_json": null,
      "draft_content_as_json": null,
      "freeform_two": false
    },
    {
      "id": 24,
      "pressroom_id": 1009,
      "title": "Test Pressroom",
      "subtitle": null,
      "release_date": null,
      "release_location": null,
      "language": "en",
      "social_media_pitch": null,
      "summary": null,
      "body_html": "<p>Autem ullam nisi mollitia consequatur enim enim. Minima ipsam sint ut ratione beatae sapiente quae minus. Molestiae est corporis et beatae tenetur amet. Quos nesciunt dicta dolores est enim voluptate. Itaque vero sint natus excepturi accusamus. Laudantium quas ipsam commodi. Delectus necessitatibus deleniti dolores quidem. Voluptatem minus optio at sunt et. Enim ullam voluptas ut. Beatae nihil voluptas est maiores. Eveniet cum nobis voluptatem et ullam quia. Harum corrupti vero et sed repellendus vel. Deserunt repellendus delectus nemo sapiente esse ea architecto velit. Debitis aliquam eveniet est asperiores. Sit amet quam aut qui at repellat ex ea.</p>",
      "permalink": "/24-test-pressroom",
      "type": "press_release",
      "state": "published",
      "short_link": "https://pr.co/p/",
      "pdf": null,
      "show_in_timeline": true,
      "content_as_json": null,
      "draft_content_as_json": null,
      "freeform_two": false
    }
  ],
  "paging": {
    "page": 0,
    "limit": 30,
    "total": 30
  }
}

Params

Param name Description
id
required

Pressroom id or pressroom domain

Validations:

  • Must be a String
includes
optional

Include attachments. To include featured images use: featured_images.

Validations:

  • Must be a String
clipping_token
optional

Include the clipping token to include private clippings

Validations:

  • Must be a String
>>>

GET /v1/pressrooms/:id/search.json

Searches a specific pressroom for tagged press releases

Supported Formats

json

Errors

Code Description
404 Missing
422 One or more of the tags specified did not exist

Examples

GET /v1/pressrooms/1009/search.json?tags=Mars&match=any
200
{
  "data": [
    {
      "id": 35,
      "pressroom_id": 1009,
      "title": "Test Pressroom",
      "subtitle": null,
      "release_date": null,
      "release_location": null,
      "language": "en",
      "social_media_pitch": null,
      "summary": null,
      "body_html": "<p>Officia eius blanditiis consequatur reiciendis consectetur. Vitae sapiente accusantium ut totam nesciunt molestias repellendus enim. Natus dolor reprehenderit odit consequatur ipsa eos. Asperiores non quod laboriosam aut enim non. Esse quia et animi impedit excepturi quia nisi. Voluptas eos et corrupti voluptas quae. Rerum aperiam expedita tempore enim magni quae libero. Consequatur qui veniam esse. Libero sed qui omnis. Qui doloremque nostrum eligendi. Quibusdam necessitatibus qui qui eum perferendis earum velit dolorem. Similique autem nulla exercitationem at numquam ipsa minus porro. Harum non porro ea qui fuga repellendus. Et aut et ullam quia. Est laudantium voluptatibus aspernatur ducimus quam repellendus molestias. Dolorem esse iusto reprehenderit harum quia ipsam assumenda molestiae. Rem dignissimos aliquam mollitia sit quas culpa beatae natus.</p>",
      "permalink": "/35-test-pressroom",
      "type": "press_release",
      "state": "published",
      "short_link": "https://pr.co/p/",
      "pdf": null,
      "show_in_timeline": true,
      "content_as_json": null,
      "draft_content_as_json": null,
      "freeform_two": false
    }
  ],
  "paging": {
    "page": 0,
    "limit": 10,
    "total": 10
  }
}

Params

Param name Description
id
required

Pressroom id or pressroom domain

Validations:

  • Must be a String
includes
optional

Include attachments. To include featured images use: featured_images.

Validations:

  • Must be a String
tags
optional

Finds press releases with these tags

Validations:

  • Must be a String
match
optional

Match all tags provided, or match any tags provided (defaults to any)

Validations:

  • Must be a String
language
optional

Search only this language

Validations:

  • Must be a String
limit
optional

Limit number of press releases returned, defaults to 30

Validations:

  • Must be a String
>>>

GET /v1/pressrooms/:id/search_releases.json

Full text search of the releases in this pressroom

Supported Formats

json

Errors

Code Description
404 Missing
422 You must provide a search term in the query parameter.

Params

Param name Description
id
required

Pressroom id or pressroom domain

Validations:

  • Must be a String
includes
optional

Include attachments. To include featured images use: featured_images.

Validations:

  • Must be a String
query
required

Text to search releases for

Validations:

  • Must be a String