Accounts /environment/accounts

The accounts attached to the current person.

Reading

GET /environment/accounts HTTP/1.1
Host: localhost:3000

Permissions

  • The applied permissions to retrieve the parent environment are required.

Fields

An array of Account objects attached to the current person and whose its retrieve permissions are granted.

Publishing

POST /environment/accounts HTTP/1.1
Host: localhost:3000

Permissions

  • An access token (pointing to an user) with publish_repertory permission is required.

Fields

Name Description Type

name

The name of the account.

string

type

The type of the account.

string

activity

The activity of the account.

string

avatar

The ID of the Photo that represents the avatar of the account.
Must be a photo owned by the current person whose its tmp field is set to true.

string

website_url

The website url of the account.

string

mails

The mail addresses of the account.

object[]

type

The type attached to the mail address.

string

address

The mail address.

string

main

If the address is the main mail.

boolean

phones

The phone numbers of the account.

object[]

type

The type attached to the phone number.

string

number

The phone number.

string

main

If the number is the main phone.

boolean

addresses

The postal addresses of the account.

object[]

type

The type attached to the postal address.

string

lane_number

The address lane number.

string

lane_name

The address lane name.

string

complement

The address complement.

string

zip

The address zip.

string

city

The address city.

string

region

The address region.

string

country

The address country.

string

main

If the address is the main address.

boolean

notes

Notes about the account.

string

custom_fields

Custom fields attached to the account.

object

tags

An array of Tag IDs at which is attached the account.
Must be some Tags belonging to the current person workspace.

string[]

privacy

The privacy of the account.

object

value

The value of the privacy.

string{WORKSPACE, SELF, CUSTOM}

perms

The privacy permission.

string{READ, SPEAK, WRITE}

allow

An array of User and/or Group IDs who have access.

string[]

deny

An array of User and/or Group IDs who don't have access.

string[]

Response

If successful :

{
    "success" : true,
    "_id" : "..."
}

Otherwise a relevant error message will be returned.

Updating

You can update accounts by using the /account edge.

Deleting

You can delete accounts by using the /account edge.