API documentation

  1. API documentation for integration with iPress

[GET] Organizations > PR Team
API version 1.0

Overview

This API returns all the datas on iPress related to a specific brand PR team.

All organizations API:

Request Link

GET: https://api.ipresslive.it/v1.0/organizations/pr-team/read/

Request Parameters

Name Description Required
token APIKEY (40-character alphanumeric string) that allows access to the API. Yes
lng Language in which the results will be returned.
Default value: IT
Possible values:
  • IT: Italian
  • EN: English
  • DE: German
 No

Request Example

GET: https://api.ipresslive.it/v1.0/organizations/pr-team/read/?token={YOUR_APIKEY}&lng={LANGUAGE_CODE}

Response Elements

Name Description Type
Organization Organization name String
Name Name of the PR account String
Link Link to the PR account profile String
Logo Logo of the PR account String
Website Website of the PR account String
Address Address of the PR account String
City City of the PR account String
PostalCode Postal code of the PR account Int
County County of the PR account String
Country Country of the PR account String
Phone Phone of the PR account String
Email Email of the PR account String
PRAccount List of information about the members of the PR account.
  • Name: name of PR account member (Type: string)
  • Surname: surname of PR account member (Type: string)
  • Image: image of PR account member (Type: string)
 Array

Response Example

								
[
  {
    "Organization": "iPress Live",
    "Name": "Lorem ipsum",
    "Link": "https://www.ipresslive.it/it/ipress/agency/view/000/",
    "Logo": "https://s3.amazonaws.com/iprs/agency/agency-logo-000.jpg",
    "Website": "https://www.ipresslive.it",
    "Address": "P.za del Duomo, 10",
    "City": "Milan",
    "PostalCode": "20100",
    "County": "MI",
    "Country": "Italy",
    "Phone": "+390000000000",
    "Email": "prteam@ipresslive.it",
    "PRAccount": [
      {
        "Name": "John",
        "Surname": "Smith",
        "Image": "https://s3.amazonaws.com/iprs/account/account-image-000.jpg"
      },
      ...
    ]
  },
  ...
]

Response Errors

Code Description
404 Not found: invalid request
401 Unauthorized: APIKEY entered invalid or no longer enabled

Response Errors Example

	
{
  "responseCode": "404",
  "responseMessage": "Not found"
}