Top

Accounts

Get Account
GET /app/api/account/
Returns information about the API caller account.
Put Account
PUT /app/api/account/
Updates information on the API caller account.
Post Account
POST /app/api/account/meta/
Creates a metadata entry for the API caller account or one of its subaccounts.
Get Account Tags
GET /app/api/account/:account_id/tags
Retrieves information about existing account tags
Post Account Tags
POST /app/api/account/:account_id/tags
Creates new tags to use in the account
Put Account Tags
PUT /app/api/account/:account_id/tags
Updates existing account tags
Delete Account Tags
DELETE /app/api/account/:account_id/tags
Deletes Account Tags

GET Account Information

GET  /app/api/account/

Returns information about the API caller account.

Response: JSON array

account_id int (12)
Returns accounts by id.
name string (255)
Returns account name.
desc string (255)
Returns account description.
type string (255)
Returns account type. [public | private]
owner_id int (12)
Returns ID of the account owner.
created_date string
Returns account creation timestamp [yyyy-mm-dd hh:mm:ss].
last_updated string
Returns account data last updated timestamp [yyyy-mm-dd hh:mm:ss].
region string (255)
Account default geographic region.

Sample Response


Status: 200 OK
Content Type: application/json;charset=UTF-8

    {
      "account_id": "12345",
      "name": "PeopleKeys API",
      "desc": "The Official PeopleKeys API",
      "type": "private",
      "owner_id": "578",
      "created_date": 2015-01-15 00:09:30,
      "last_updated": 2015-01-15 00:10:37,
      "region": "en_US"
    }


PUT Account Information

PUT  /app/api/account/

Updates information on the API caller account.

HTTP Form Parameters

account_id int (12)
Puts accounts by id.
name string (255)
Puts account name.
desc string (255)
Puts account description.
type string (255)
Puts account type. [public | private]
region string (255)
Puts account default geographic region.

Sample Response


Status: 200 OK
Content Type: application/json;charset=UTF-8

    {
      "account_id": "12345",
      "name": "PeopleKeys API",
      "desc": "The Official PeopleKeys API",
      "type": "private",
      "region": "en_US"
    }


POST Account Information

Post  /app/api/account/meta/

Creates a metadata entry for the API caller account or one of its subaccounts.

HTTP Form Parameters

account_id int (12)
Puts accounts by id.
key string (40)
Puts the meta-entry name.
value string (255)
Puts the meta-entry value.

Sample Response


Status: 200 OK
Content Type: application/json;charset=UTF-8

    {
      "account_id": "12345",
      "key": "Company Name",
      "value": "PeopleKeys"
     
    }


GET Account Tag Information

GET  /app/api/account/:account_id/tags

Retrieves information about existing account tags.

HTTP URL Parameters

account_id int (12)
ID of the account

Response: JSON array

tag string (??)
tag name.
count int (??)
Number of PK3 users and/or external users associated with the tag.

Sample Response


Status: 200 OK
Content Type: application/json;charset=UTF-8
[
    {
      "tag": "hiring",
      "count": "55"
    },
    ...
]

POST Account Tags

POST  /app/api/account/:account_id/tags

Creates new tags to use in the account.

HTTP URL Parameters

account_id int (12)
ID of the account

HTTP Form Parameters

tags JSON array
{
    tag_list = [...]
}
tag_list string (??)
list of tags to be created in the account

Response: JSON array

tags_affected INT ??
number of listed tags renamed

Sample Response


Status: 200 OK
Content Type: application/json;charset=UTF-8

    {
        tags_affected
    }


PUT Account Tags

PUT  /app/api/account/:account_id/tags

Updates existing account tags.

HTTP URL Parameters

account_id int (12)
ID of the account

HTTP Form Parameters

tags JSON array
{
    tag_list = [
        {
              old name,
              new_name
        },
        ...
    ]
}
tag_list string (??)
list of tags to be created in the account
old_name string (??)
old tag name
new_name string (??)
new tag name

Response: JSON array

tags_affected INT ??
number of listed tags renamed

Sample Response


Status: 200 OK
Content Type: application/json;charset=UTF-8

    {
        tags_affected
    }


DELETE Account Tags

DELETE  /app/api/account/:account_id/tags?tags=":tags"

Deletes account tags

HTTP URL Parameters

account_id int (12)
ID of the account

HTTP GET Parameters

tags JSON array
{
    tag_list = [...]
}
tag_list string (??)
list of tags to be created in the account

Response: JSON array

tags_affected INT ??
number of listed tags renamed

Sample Response


Status: 200 OK
Content Type: application/json;charset=UTF-8

    {
        tags_affected
    }