Publishers

This API is only available for Accounts that are defined as Contacts to other Accounts. Publishers are other Accounts that share presentations with the current Account. This option is only available for some Custom subscription plans - contact us for details.

Publishers list

Publishers API returns details about each publisher:

URL: https://orbitvu.co/api/v1/publishers [.json|.xml]

Returned value

[
    {
        "id": 1,
        "name": "ORBITVU",
        "email": "example@orbitvu.pl",
        "url": "https://orbitvu.co/api/v1/publishers/1/",
        "shares_url": "https://orbitvu.co/api/api/v1/publishers/1/shares"
    },
    {
        "id": 2,
        "name": "ORBITVU 2",
        "email": "example+2@orbitvu.com",
        "url": "https://orbitvu.co/api/v1/publishers/2/",
        "shares_url": "https://orbitvu.co/api/v1/publishers/2/shares"
    }
]

Searching

  • exact

    Search for contacts by exact match to specific fields: id, name, email, eg.:

    # match publisher with id == 1
    https://orbitvu.co/api/v1/publishers.json?id=1
    
    # match publisher with email example@orbitvu.com
    https://orbitvu.co/api/v1/publishers.json?email=example@orbitvu.com
  • ilike - single

    Search for publishers containing specific pattern within one of: name, email:

    # match all publishers with name or email containing 'A123' or 'a123'
    https://orbitvu.co/api/v1/publishers/?search=A123

Ordering

Order by: id, name:

# ascending
https://orbitvu.co/api/v1/publishers/?ordering=id
# descending
https://orbitvu.co/api/v1/publishers/?ordering=-id

Publisher details

Details of specific publisher are available at:

URL: https://orbitvu.co/api/v1/publishers/<id>/ [.json|.xml]

Sample data returned:

{
    "id": 1,
    "name": "ORBITVU",
    "email": "example@orbitvu.com",
    "url": "https://orbitvu.co/api/v1/publishers/1/",
    "shares_url": "https://orbitvu.co/api/v1/publishers/1/shares/"
}

shares_url is analogous to shares_url defined for contacts and its description can be found there.