1. API
  2. v1
  3. CORE
  4. USERS

Profile

Resource Fields

Name Type Read-only Description
full_name string
designation string
is_otp_enabled boolean
avatar string
organization Organization
teams Teams
emails Emails
phones Phones
twitter Twitter
facebook Facebook
external_identifiers External Identifiers
addresses Addresses
websites Websites
custom_fields Fields
locale Locale
time_zone string
greeting string
signature string
status_message string
last_login_at timestamp ISO-8601 Format
created_at timestamp ISO-8601 Format
updated_at timestamp ISO-8601 Format



Metadata




 
 



Version 1.0
Last Updated July 04, 2016

Actions

Retrieve profile

GET /api/v1/profile.json

Information

Allowed for Customers, Collaborators, Agents, Admins & Owners

Response

    {
        "status": 200,
        "data": {
    "id": 1,

    "full_name": "Phoebe Todd",
    "designation": null,
    "is_otp_enabled": false,
    "avatar": "https://brewfictus.kayako.com/avatar/get/7b3b3fea-b6ba-55c8-8c72-31ba4fb52e78",
    "agent_case_access": "ALL",
    "organization_case_access": null,
    "organization": {
    "id": 1,

    "resource_type": "organization"

}
,
    "teams": [
        {
    "id": 1,
    "legacy_id": null,

    "resource_type": "team"

}
    ],
    "emails": [
        {
    "id": 1,

    "resource_type": "identity_email"

}
    ],
    "phones": [],
    "twitter": [],
    "facebook": [],
    "external_identifiers": [],
    "addresses": [],
    "websites": [],
    "custom_fields": [
        {
            "field": {
    "id": 1,

    "resource_type": "user_field"

}
,
            "value": "",
            "resource_type": "user_field_value"
        }
    ],
    "locale": "en-us",
    "time_zone": null,
    "time_zone_offset": null,
    "greeting": null,
    "signature": null,
    "status_message": null,
    "last_seen_user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/44.0.2403.125 Safari/537.36",
    "last_seen_ip": "89.76.11.90",
    "last_login_at": "2015-08-04T06:20:32+05:00",
    "created_at": "2015-08-04T05:16:39+05:00",
    "updated_at": "2015-08-04T06:38:33+05:00",

    "resource_type": "profile"

    ,"resource_url": "https://brewfictus.kayako.com/api/v1/profile"

}
,
        "resource": "profile"
    }

Update profile

PUT /api/v1/profile.json

Information

Allowed for Customers, Collaborators, Agents, Admins & Owners

Parameters

Name Type Mandatory Description
full_name string
designation string
locale_id integer Locales
time_zone string
signature string
field_values string
avatar multipart/form-data

Response

    {
        "status": 200,
        "data": {
    "id": 1,

    "full_name": "Phoebe Todd",
    "designation": null,
    "is_otp_enabled": false,
    "avatar": "https://brewfictus.kayako.com/avatar/get/7b3b3fea-b6ba-55c8-8c72-31ba4fb52e78",
    "agent_case_access": "ALL",
    "organization_case_access": null,
    "organization": {
    "id": 1,

    "resource_type": "organization"

}
,
    "teams": [
        {
    "id": 1,
    "legacy_id": null,

    "resource_type": "team"

}
    ],
    "emails": [
        {
    "id": 1,

    "resource_type": "identity_email"

}
    ],
    "phones": [],
    "twitter": [],
    "facebook": [],
    "external_identifiers": [],
    "addresses": [],
    "websites": [],
    "custom_fields": [
        {
            "field": {
    "id": 1,

    "resource_type": "user_field"

}
,
            "value": "",
            "resource_type": "user_field_value"
        }
    ],
    "locale": "en-us",
    "time_zone": null,
    "time_zone_offset": null,
    "greeting": null,
    "signature": null,
    "status_message": null,
    "last_seen_user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/44.0.2403.125 Safari/537.36",
    "last_seen_ip": "89.76.11.90",
    "last_login_at": "2015-08-04T06:20:32+05:00",
    "created_at": "2015-08-04T05:16:39+05:00",
    "updated_at": "2015-08-04T06:38:33+05:00",

    "resource_type": "profile"

    ,"resource_url": "https://brewfictus.kayako.com/api/v1/profile"

}
,
        "resource": "profile"
    }

Delete an avatar

DELETE /api/v1/profile/avatar.json

Information

Allowed for Customers, Collaborators, Agents, Admins & Owners

Response

{
    "status": 200
}

Change password

PUT /api/v1/profile/password.json

Information

Allowed for Customers, Collaborators, Agents, Admins & Owners

Parameters

Name Type Mandatory Description
password string
new_password string

Response

{
    "status": 200
}

Validate email

PUT /api/v1/profile/verify.json

Information

Allowed for Public

Parameters

Name Type Mandatory Description
hash string

Response

{
    "status": 200
}

Emails

RESOURCE FIELDS

Name Type Read-only Description
email string
is_primary boolean Default: false
is_validated boolean Default: false
is_notification_enabled boolean Default: false
created_at timestamp
ISO-8601 Format
updated_at timestamp
ISO-8601 Format

Retrieve all emails

GET /api/v1/profile/identities/emails.json

Information

Allowed for Customers, Collaborators, Agents, Admins & Owners
Ordered by is_primary, updated_at (descending)

Response

    {
        "status": 200,
        "data": [
            {
    "id": 1,

    "email": "simon.blackhouse@brewfictus.com",
    "is_primary": true,
    "is_validated": true,
    "is_notification_enabled": false,
    "created_at": "2016-04-22T11:52:04+00:00",
    "updated_at": "2016-04-22T11:52:30+00:00",

    "resource_type": "identity_email"

    ,"resource_url": "https://brewfictus.kayako.com/api/v1/identities/emails/1"

}
        ],
        "resource": "identity_email",
        "offset": 0,
        "limit": 10,
        "total_count": 1
    }

Retrieve an email

GET /api/v1/profile/identities/emails/:id.json

Information

Allowed for Customers, Collaborators, Agents, Admins & Owners

Response

    {
        "status": 200,
        "data": {
    "id": 1,

    "email": "simon.blackhouse@brewfictus.com",
    "is_primary": true,
    "is_validated": true,
    "is_notification_enabled": false,
    "created_at": "2016-04-22T11:52:04+00:00",
    "updated_at": "2016-04-22T11:52:30+00:00",

    "resource_type": "identity_email"

    ,"resource_url": "https://brewfictus.kayako.com/api/v1/identities/emails/1"

},
        "resource": "identity_email"
    }

Add an email

POST /api/v1/profile/identities/emails.json

Information

Allowed for Customers, Collaborators, Agents, Admins & Owners

Parameters

Name Type Mandatory Description
email string
is_primary boolean Default: false
is_notification_enabled boolean Default: false

Response

    {
        "status": 201,
        "data": {
    "id": 1,

    "email": "simon.blackhouse@brewfictus.com",
    "is_primary": true,
    "is_validated": true,
    "is_notification_enabled": false,
    "created_at": "2016-04-22T11:52:04+00:00",
    "updated_at": "2016-04-22T11:52:30+00:00",

    "resource_type": "identity_email"

    ,"resource_url": "https://brewfictus.kayako.com/api/v1/identities/emails/1"

},
        "resource": "identity_email"
    }

Mark as primary

PUT /api/v1/profile/identities/emails/:id/primary.json

Information

Allowed for Customers, Collaborators, Agents, Admins & Owners

Response

    {
        "status": 200,
        "data": {
    "id": 1,

    "email": "simon.blackhouse@brewfictus.com",
    "is_primary": true,
    "is_validated": true,
    "is_notification_enabled": false,
    "created_at": "2016-04-22T11:52:04+00:00",
    "updated_at": "2016-04-22T11:52:30+00:00",

    "resource_type": "identity_email"

    ,"resource_url": "https://brewfictus.kayako.com/api/v1/identities/emails/1"

},
        "resource": "identity_email"
    }

Send a verification email

PUT /api/v1/profile/identities/emails/:id/verification.json

Information

Allowed for Customers, Collaborators, Agents, Admins & Owners

Response

    {
        "status": 200,
        "data": {
    "id": 1,

    "email": "simon.blackhouse@brewfictus.com",
    "is_primary": true,
    "is_validated": true,
    "is_notification_enabled": false,
    "created_at": "2016-04-22T11:52:04+00:00",
    "updated_at": "2016-04-22T11:52:30+00:00",

    "resource_type": "identity_email"

    ,"resource_url": "https://brewfictus.kayako.com/api/v1/identities/emails/1"

},
        "resource": "identity_email"
    }

Delete an email

DELETE /api/v1/profile/identities/emails/:id.json

Information

Allowed for Customers, Collaborators, Agents, Admins & Owners

Response

{
    "status": 200
}

Delete emails

DELETE /api/v1/profile/identities/emails.json

Information

Allowed for Customers, Collaborators, Agents, Admins & Owners

Arguments

Name Type Mandatory Description
ids string
The comma separated ids

Response

{
    "status": 200,
    "total_count": 2
}

Phones

RESOURCE FIELDS

Name Type Read-only Description
number string
type string NONE, HOME, WORK, MOBILE

Default: NONE
is_primary boolean Default: false
created_at timestamp
ISO-8601 Format
updated_at timestamp
ISO-8601 Format

Retrieve all phones

GET /api/v1/profile/identities/phones.json

Information

Allowed for Customers, Collaborators, Agents, Admins & Owners
Ordered by is_primary, updated_at (descending)

Response

{
    "status": 200,
    "data": [
        {
            "id": 3,
            "number": "+14515550197",
            "is_primary": true,
            "is_validated": false,
            "created_at": "2015-09-11T07:05:59+05:00",
            "updated_at": "2015-09-11T07:05:59+05:00",
            "resource_type": "identity_phone",
            "resource_url": "https://brewfictus.kayako.com/api/v1/profile/identities/phones/3"
        }
    ],
    "resource": "identity_phone",
    "offset": 0,
    "limit": 10,
    "total_count": 1
}

Retrieve a phone

GET /api/v1/profile/identities/phones/:id.json

Information

Allowed for Customers, Collaborators, Agents, Admins & Owners

Response

{
    "status": 200,
    "data": {
        "id": 3,
        "number": "+14515550197",
        "is_primary": true,
        "is_validated": false,
        "created_at": "2015-09-11T07:05:59+05:00",
        "updated_at": "2015-09-11T07:05:59+05:00",
        "resource_type": "identity_phone",
        "resource_url": "https://brewfictus.kayako.com/api/v1/profile/identities/phones/3"
    },
    "resource": "identity_phone"
}

Add a phone

POST /api/v1/profile/identities/phones.json

Information

Allowed for Customers, Collaborators, Agents, Admins & Owners

Parameters

Name Type Mandatory Description
number string
type string NONE, HOME, WORK, MOBILE

Default: NONE
is_primary boolean Default: false

Response

{
    "status": 201,
    "data": {
        "id": 3,
        "number": "+14515550197",
        "is_primary": true,
        "is_validated": false,
        "created_at": "2015-09-11T07:05:59+05:00",
        "updated_at": "2015-09-11T07:05:59+05:00",
        "resource_type": "identity_phone",
        "resource_url": "https://brewfictus.kayako.com/api/v1/profile/identities/phones/3"
    },
    "resource": "identity_phone"
}

Mark as primary

PUT /api/v1/profile/identities/phones/:id/primary.json

Information

Allowed for Customers, Collaborators, Agents, Admins & Owners

Response

{
    "status": 200,
    "data": {
        "id": 3,
        "number": "+14515550197",
        "is_primary": true,
        "is_validated": false,
        "created_at": "2015-09-11T07:05:59+05:00",
        "updated_at": "2015-09-11T07:09:06+05:00",
        "resource_type": "identity_phone",
        "resource_url": "https://brewfictus.kayako.com/api/v1/profile/identities/phones/3"
    },
    "resource": "identity_phone"
}

Delete a phone

DELETE /api/v1/profile/identities/phones/:id.json

Information

Allowed for Customers, Collaborators, Agents, Admins & Owners

Response

{
    "status": 200
}

Delete phones

DELETE /api/v1/profile/identities/phones.json

Information

Allowed for Customers, Collaborators, Agents, Admins & Owners

Arguments

Name Type Mandatory Description
ids string
The comma separated ids

Response

{
    "status": 200,
    "total_count": 2
}

Twitter accounts

RESOURCE FIELDS

Name Type Read-only Description
twitter_id string
full_name string
screen_name string
follower_count integer
description string
url string
location string
profile_image_url string
locale string
is_verified boolean
Default: false
is_primary boolean Default: false
created_at timestamp
ISO-8601 Format
updated_at timestamp
ISO-8601 Format

Retrieve all accounts

GET /api/v1/profile/identities/twitter.json

Information

Allowed for Customers, Collaborators, Agents, Admins & Owners
Ordered by is_primary, updated_at (descending)

Response

    {
        "status": 200,
        "data": [



{
    "id": 1,

    "twitter_id": "3156012171",
    "full_name": "Phoebe Todd",
    "screen_name": "phoebetodd",
    "follower_count": 0,
    "description": null,
    "url": null,
    "location": null,
    "profile_image_url": null,
    "locale": "en",
    "is_verified": false,
    "is_primary": false,
    "is_validated": false,
    "created_at": "2015-07-25T15:02:02+05:00",
    "updated_at": "2015-07-25T15:02:02+05:00",

    "resource_type": "identity_twitter"

    ,"resource_url": "https://brewfictus.kayako.com/api/v1/identities/twitter/1"

}
        ],
        "resource": "identity_twitter",
        "offset": 0,
        "limit": 10,
        "total_count": 1
    }

Retrieve an account

GET /api/v1/profile/identities/twitter/:id.json

Information

Allowed for Customers, Collaborators, Agents, Admins & Owners

Response

     {
        "status": 200,
        "data": 


{
    "id": 1,

    "twitter_id": "3156012171",
    "full_name": "Phoebe Todd",
    "screen_name": "phoebetodd",
    "follower_count": 0,
    "description": null,
    "url": null,
    "location": null,
    "profile_image_url": null,
    "locale": "en",
    "is_verified": false,
    "is_primary": false,
    "is_validated": false,
    "created_at": "2015-07-25T15:02:02+05:00",
    "updated_at": "2015-07-25T15:02:02+05:00",

    "resource_type": "identity_twitter"

    ,"resource_url": "https://brewfictus.kayako.com/api/v1/identities/twitter/1"

},
        "resource": "identity_twitter"
    }

Mark as primary

PUT /api/v1/profile/identities/twitter/:id/primary.json

Information

Allowed for Customers, Collaborators, Agents, Admins & Owners

Response

    {
        "status": 200,
        "data": 


{
    "id": 1,

    "twitter_id": "3156012171",
    "full_name": "Phoebe Todd",
    "screen_name": "phoebetodd",
    "follower_count": 0,
    "description": null,
    "url": null,
    "location": null,
    "profile_image_url": null,
    "locale": "en",
    "is_verified": false,
    "is_primary": false,
    "is_validated": false,
    "created_at": "2015-07-25T15:02:02+05:00",
    "updated_at": "2015-07-25T15:02:02+05:00",

    "resource_type": "identity_twitter"

    ,"resource_url": "https://brewfictus.kayako.com/api/v1/identities/twitter/1"

},
        "resource": "identity_twitter"
    }

Delete an account

DELETE /api/v1/profile/identities/twitter/:id.json

Information

Allowed for Customers, Collaborators, Agents, Admins & Owners

Response

{
    "status": 200
}

Delete accounts

DELETE /api/v1/profile/identities/twitter.json

Information

Allowed for Customers, Collaborators, Agents, Admins & Owners

Arguments

Name Type Mandatory Description
ids string
The comma separated ids

Response

{
    "status": 200,
    "total_count": 2
}

Facebook accounts

RESOURCE FIELDS

Name Type Read-only Description
facebook_id string
user_name string
full_name string
email string
bio string
birth_date timestamp
ISO-8601 Format
website string
profile_url string
locale string
is_verified boolean
Default: false
is_primary boolean Default: false
created_at timestamp
ISO-8601 Format
updated_at timestamp
ISO-8601 Format

Retrieve all accounts

GET /api/v1/profile/identities/facebook.json

Information

Allowed for Customers, Collaborators, Agents, Admins & Owners
Ordered by is_primary, updated_at (descending)

Response

    {
        "status": 200,
        "data": [
            {
    "id": 1,

    "facebook_id": "1407638772888867",
    "user_name": null,
    "full_name": "Jordan Mitchell",
    "email": null,
    "bio": null,
    "birth_date": null,
    "website": null,
    "profile_url": null,
    "locale": null,
    "is_verified": false,
    "is_primary": false,
    "is_validated": false,
    "created_at": "2015-07-25T17:47:14+05:00",
    "updated_at": "2015-07-25T17:47:14+05:00",

    "resource_type": "identity_facebook"

    ,"resource_url": "https://brewfictus.kayako.com/api/v1/identities/facebook/1"

}

        ],
        "resource": "identity_facebook",
        "offset": 0,
        "limit": 10,
        "total_count": 1
    }

Retrieve an account

GET /api/v1/profile/identities/facebook/:id.json

Information

Allowed for Customers, Collaborators, Agents, Admins & Owners

Response

    {
        "status": 200,
        "data": {
    "id": 1,

    "facebook_id": "1407638772888867",
    "user_name": null,
    "full_name": "Jordan Mitchell",
    "email": null,
    "bio": null,
    "birth_date": null,
    "website": null,
    "profile_url": null,
    "locale": null,
    "is_verified": false,
    "is_primary": false,
    "is_validated": false,
    "created_at": "2015-07-25T17:47:14+05:00",
    "updated_at": "2015-07-25T17:47:14+05:00",

    "resource_type": "identity_facebook"

    ,"resource_url": "https://brewfictus.kayako.com/api/v1/identities/facebook/1"

}
,
        "resource": "identity_facebook"
    }

Mark as primary

PUT /api/v1/profile/identities/facebook/:id/primary.json

Information

Allowed for Customers, Collaborators, Agents, Admins & Owners

Response

    {
        "status": 200,
        "data": {
    "id": 1,

    "facebook_id": "1407638772888867",
    "user_name": null,
    "full_name": "Jordan Mitchell",
    "email": null,
    "bio": null,
    "birth_date": null,
    "website": null,
    "profile_url": null,
    "locale": null,
    "is_verified": false,
    "is_primary": false,
    "is_validated": false,
    "created_at": "2015-07-25T17:47:14+05:00",
    "updated_at": "2015-07-25T17:47:14+05:00",

    "resource_type": "identity_facebook"

    ,"resource_url": "https://brewfictus.kayako.com/api/v1/identities/facebook/1"

}
,
        "resource": "identity_facebook"
    }

Delete an account

DELETE /api/v1/profile/identities/facebook/:id.json

Information

Allowed for Customers, Collaborators, Agents, Admins & Owners

Response

{
    "status": 200
}

Delete accounts

DELETE /api/v1/profile/identities/facebook.json

Information

Allowed for Customers, Collaborators, Agents, Admins & Owners

Arguments

Name Type Mandatory Description
ids string
The comma separated ids

Response

{
    "status": 200,
    "total_count": 2
}

Two Factor

RESOURCE FIELDS

Name Type Read-only Description
recovery_codes array
When two factor authentication is enabled/updated, a set of 10 recovery codes is generated to be used if authenticator app is unavailable for some reason.

Token

RESOURCE FIELDS

Name Type Read-only Description
token string
qr_code string
base64 encoded image data
qr_code_type string
image type e.g. "image/png"

Generate a token

GET /api/v1/profile/twofactor.json

Information

Allowed for Customers, Collaborators, Agents, Admins & Owners

Response

{
    "status": 200,
    "data": {
        "token": "JfZgjFdKaK0ZyeLCjDt3OXdSg3G5dKY5LDGGQPsWKtzHNNy1nMZ+y5ur",
        "qr_code": "iVBORw0KGgoAAAANSUhEUgAAAZoAAAGaAQMAAAAMyBcgAAAABlBMVEX///8AAABVwtN+AAAACXBIWXMAAA7EAAAOxAGVKw4bAAACEUlEQVR4nO2ZTW6EMAyFLXGAORJX50gcAMlN7GeHUNSq6i5+b8EQ4i+zsfwXEYqiKIqiqP9IoUtkP/uHj6rsGo++dB2EikC++FwNP7e2Z9CJjba8JjtCBaDuKLYHv+lW5jx+Rj+tORmhepBZDYfyN0KFIVjZ13AjnEGoFORWcBnPMmblpr/lJ0LLQVAEkW+PMCBUBHqo7fWSoz1aLfIIJ4RKQPCRT/iSay5DdlsSqgG5dt/LN8UZ+PYeWAgtCfmeeN2x+V5znml+0TX9B6GFIdSf3d73whQzDULVIA8Yu214RokQk6nGvIpQFcirzvtQU/V+ht+NPAtTQgtDnmWcxBkmtKwSpBCqAY0WBHVHppXdYwqaV0JVIHjQGGtJNChj7nnIU4QWhnDxITJKjvCqLavT7dnnEloXsqiR1QZ0SmYefctPhNaFovsY88xwmT2Cza2NJVQAwhW6xhVIehBa1qhPCFWBNFtWvRUaUYm+pxpCK0O2GC2I5Zbb1GL0rYSqQBFTFF1KhpiB+zdCdaCnQcYUNR3fAwuhZaEJv24HwasEtQihKpBCyChehphBNiiv5SihZSEzyGEWZpwT/pZqCC0Mect6pUNpjDOmVCNCqBx05NQCBUkMwUewIVQLsqX3JpdPNyLiyCxCS0P2c/MgzLFisDHeCNWAIJSjghlndil+k/pzDUtoJYiiKIqiKOrv+gJ4PgUravidagAAAABJRU5ErkJggg==",
        "qr_code_type": "image/png"
    },
    "resource": "twofactor_token"
}

Enable two factor

POST /api/v1/profile/twofactor.json

Information

Allowed for Customers, Collaborators, Agents, Admins & Owners

Parameters

Name Type Mandatory Description
token string
Token linked with the QR Code received from api
otp integer
Generated by authenticator application after scanning QR Code

Response

{
    "status": 201,
    "data": {
        "recovery_codes": [
            "3yqQQ ALyxE Xuhb6",
            "mKBO6 NsAim LrbCA",
            "HYE7r KfC1x SSn7D",
            "Dr0Ew GHq05 1N5Wp",
            "3rUez qNW1F Mod14",
            "pw6A1 h3DcQ 5dQRo",
            "hHkZ0 hNxst jg77q",
            "UcckF HGJ2G qiqlJ",
            "jT4wj HE7cn Oq59a",
            "Alyat iphqt dZMh4"
        ]
    },
    "resource": "twofactor_recoverycodes"
}

Update a token

PUT /api/v1/profile/twofactor.json

Information

Allowed for Customers, Collaborators, Agents, Admins & Owners

Parameters

Name Type Mandatory Description
token string
Token linked with the QR Code received from api
otp integer
Generated by authenticator application after scanning QR Code

Response

{
    "status": 200,
    "data": {
        "recovery_codes": [
            "ZZK1s C7VmS AwHLA",
            "ST3bc SMBWW Y7h5F",
            "0aYVN 36AX2 1hcuq",
            "bJn6X 05qvG XdIgk",
            "A7pDg OZ97i 88ueo",
            "xIelG s0mau mw6HO",
            "QGWvg 644Ys obOeg",
            "cwd3u G9Pcn ilYj3",
            "B0qho jWqwz lXL4A",
            "zuxsO QK81q R1lJI"
        ]
    },
    "resource": "twofactor_recoverycodes"
}

Fields

RESOURCE FIELDS

Name Type Read-only Description
fielduuid string
title string
type string
key string
is_visible_to_customers boolean
customer_title Field Locales
is_customer_editable boolean
is_required_for_customers boolean
description string
regular_expression string
sort_order integer
Default: false
is_enabled boolean Default: false
options Options
created_at timestamp
ISO-8601 Format
updated_at timestamp
ISO-8601 Format

Retrieve all fields

GET /api/v1/profile/fields.json

Information

Allowed for Customers, Collaborators, Agents, Admins & Owners
Ordered by sort_order (ascending)

Response

    {
        "status": 200,
        "data": {
    "id": 1,

    "fielduuid": "2ae7907f-8d83-4ffe-875c-f53c6c51571c",
    "title": "Industry",
    "type": "TEXT",
    "key": "industry",
    "is_visible_to_customers": true,
    "customer_titles": 

[






{
    "id": 1,

    "resource_type": "locale_field"

},






{
    "id": 2,

    "resource_type": "locale_field"

}    
],
    "is_customer_editable": true,
    "is_required_for_customers": true,
    "descriptions": [],
    "regular_expression": null,
    "sort_order": 1,
    "is_enabled": true,
    "options": [],
    "created_at": "2015-11-20T06:22:57+05:00",
    "updated_at": "2015-11-20T06:22:57+05:00",

    "resource_type": "profile_field"

    ,"resource_url": "https://brewfictus.kayako.com/api/v1/profile/fields/1"

}
,
        "resource": "profile_field"
    }

Retrieve a field

GET /api/v1/profile/fields/:id.json

Information

Allowed for Customers, Collaborators, Agents, Admins & Owners

Response

     {
        "status": 200,
        "data": [
            {
    "id": 1,

    "fielduuid": "2ae7907f-8d83-4ffe-875c-f53c6c51571c",
    "title": "Industry",
    "type": "TEXT",
    "key": "industry",
    "is_visible_to_customers": true,
    "customer_titles": 

[






{
    "id": 1,

    "resource_type": "locale_field"

},






{
    "id": 2,

    "resource_type": "locale_field"

}    
],
    "is_customer_editable": true,
    "is_required_for_customers": true,
    "descriptions": [],
    "regular_expression": null,
    "sort_order": 1,
    "is_enabled": true,
    "options": [],
    "created_at": "2015-11-20T06:22:57+05:00",
    "updated_at": "2015-11-20T06:22:57+05:00",

    "resource_type": "profile_field"

    ,"resource_url": "https://brewfictus.kayako.com/api/v1/profile/fields/1"

}

        ],
        "resource": "profile_field",
        "total_count": 2
    }