Users

With the user object, you can enrich your articles with biographical information about an author (or authors). The user object is a merge of profile information provided by the users themselves, and what you have set for the user in your publication’s user administration.

The User Object

Key	Description
id	Unique identifier for the object.
createdAt	ISO date at which the object was created. This is not the timestamp at which the user signed up, but at which the user was first added to your publication.
bio	Bio with up to 1,000 characters which you can edit in your publication’s user administration.
email	Email address which you can edit in your publication’s user administration.
externalId	An external ID can be useful if you maintain your own user accounts and would like to create a reference to a user in it.
image.hash	Unique image file identifier (hash).
image.resolutions	Thumbnail image URLs in various resolutions: default (80px), 160, 320, 540 and 1080. We use imgix for adaptive image processing and delivery. If the provided resolutions are inadequate, you can perform your own image transformations with the image.hash.
name	Name of the user.
phone	Phone number which you can edit in your publication’s user administration.
articlesCount	Count of articles this user has written for the publication.
profiles	URLs to various social media profiles that the user has provided in the profile settings.
slug	Auto-generated slug based on the name. This is not necessarily unique if you have more than one user in your publication with the identical name.
title	Job title or position which you can edit in your publication’s user administration.
updatedAt	ISO date at which the object was last modified.
website	Personal website URL that the user has provided in the profile settings.

List All Users

Retrieves a list of user objects associated with your publication.

Request

curl -X GET https://api.postodian.com/v1/users \
     -H "X-API-KEY: pk_febaf9ad8a2dc82a16d1d923" \

Response

{
  "hasMore": false,
  "users": [
    {
      "id": "DQfg-HWhQ",
      "articlesCount": 4,
      "bio": "Donec neque ipsum, eleifend ac augue vel, mattis sollicitudin erat. Mauris vitae purus a neque vulputate malesuada. Nullam cursus ullamcorper diam, sed pretium metus varius et. Nullam tincidunt ullamcorper mi, vitae tristique est congue ut. Integer vel dolor auctor, pretium ligula quis, placerat lectus.",
      "email": "michael@writer.com",
      "externalId": null,
      "image": {
        "hash": null,
        "resolutions": {
          "default": null,
          "160": null,
          "320": null,
          "540": null,
          "1080": null
        }
      },
      "name": "Michael Writer",
      "phone": null,
      "profiles": {
        "instagram": null,
        "linkedin": null,
        "twitter": null
      },
      "slug": "michael-writer",
      "title": "Lead Editor",
      "website": null
    }
  ],
  "usersCount": 1
}

Retrieve a Single User

Retrieves a user object by its unique identifier.

Request

curl -X GET https://api.postodian.com/v1/users/:id \
     -H "X-API-KEY: pk_febaf9ad8a2dc82a16d1d923" \

Response

{
  "id": "DQfg-HWhQ",
  "articlesCount": 4,
  "bio": "Donec neque ipsum, eleifend ac augue vel, mattis sollicitudin erat. Mauris vitae purus a neque vulputate malesuada. Nullam cursus ullamcorper diam, sed pretium metus varius et. Nullam tincidunt ullamcorper mi, vitae tristique est congue ut. Integer vel dolor auctor, pretium ligula quis, placerat lectus.",
  "email": "michael@writer.com",
  "externalId": null,
  "image": {
    "hash": null,
    "resolutions": {
      "default": null,
      "160": null,
      "320": null,
      "540": null,
      "1080": null
    }
  },
  "name": "Michael Writer",
  "phone": null,
  "profiles": {
    "instagram": null,
    "linkedin": null,
    "twitter": null
  },
  "slug": "michael-writer",
  "title": "Lead Editor",
  "website": null
}