{
"opencollection": "1.0.0",
"info": {
"name": "Nutshell Contacts (People) API",
"version": "2.0.0"
},
"items": [
{
"info": {
"name": "Contacts (People)",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get a contact",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://app.nutshell.com/rest/contacts/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Contact ID"
}
],
"auth": {
"type": "basic",
"username": "{{username}}",
"password": "{{password}}"
}
},
"docs": "Returns a single contact based on the provided ID."
},
{
"info": {
"name": "Update a contact",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://app.nutshell.com/rest/contacts/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Ids are of the form 'n-contacts', where n is an integer."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "basic",
"username": "{{username}}",
"password": "{{password}}"
}
},
"docs": "Update a contact by id.
op is the operation to be performed, and path specifies what resource to patch.
Use the path contacts/0/fieldName to update fields that are user-entered for this resource, i.e. name, description, etc.
Use the path contacts/0/links/fieldName to update this contact's links to other resources within Nutshell, i.e. accounts, owner, territory, emAudiences, etc. When performing an 'add', include a /- at the end of the path, i.e. contacts/0/links/fiel"
},
{
"info": {
"name": "Delete a contact",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://app.nutshell.com/rest/contacts/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Contact ID"
}
],
"auth": {
"type": "basic",
"username": "{{username}}",
"password": "{{password}}"
}
},
"docs": "Deletes a contact from Nutshell. Can be recovered by posting to /contacts/{id}/undelete"
},
{
"info": {
"name": "Get contact custom fields",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://app.nutshell.com/rest/contacts/:id/customfields",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Contact ID"
}
],
"auth": {
"type": "basic",
"username": "{{username}}",
"password": "{{password}}"
}
},
"docs": "Returns a list of custom fields for a contact."
},
{
"info": {
"name": "Get applicable custom fields",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://app.nutshell.com/rest/contacts/customfields/attributes",
"auth": {
"type": "basic",
"username": "{{username}}",
"password": "{{password}}"
}
},
"docs": "Get a list of all custom fields that can be applied to any contact."
},
{
"info": {
"name": "Create a custom field",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://app.nutshell.com/rest/contacts/customfield",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "basic",
"username": "{{username}}",
"password": "{{password}}"
}
},
"docs": "Creates a custom field to use for contacts."
},
{
"info": {
"name": "Get a list of contacts",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://app.nutshell.com/rest/contacts",
"params": [
{
"name": "email",
"value": "",
"type": "query",
"description": "Returns contacts with the provided email address."
},
{
"name": "q",
"value": "",
"type": "query",
"description": "Returns contacts with a piece of information similar to the provided string, such as name, email, location, etc."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "What criteria to order the returned list of results."
},
{
"name": "filter",
"value": "",
"type": "query"
},
{
"name": "page[page]",
"value": "",
"type": "query",
"description": "The page of results to return. Indexing is 0-based."
},
{
"name": "page[limit]",
"value": "",
"type": "query",
"description": "How many results to return per page"
}
],
"auth": {
"type": "basic",
"username": "{{username}}",
"password": "{{password}}"
}
},
"docs": "Returns a number of contacts which is filterable based on their basic information."
},
{
"info": {
"name": "Create a contact",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://app.nutshell.com/rest/contacts",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "basic",
"username": "{{username}}",
"password": "{{password}}"
}
},
"docs": "Create a new contact, also known as a person, in Nutshell. Only one contact may be created at a time."
},
{
"info": {
"name": "Undelete a contact",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://app.nutshell.com/rest/contacts/:id/undelete",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Contact ID"
}
],
"auth": {
"type": "basic",
"username": "{{username}}",
"password": "{{password}}"
}
},
"docs": "Undelete a contact"
},
{
"info": {
"name": "Get list items for all contacts",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://app.nutshell.com/rest/contacts/list",
"params": [
{
"name": "filter",
"value": "",
"type": "query"
},
{
"name": "q",
"value": "",
"type": "query",
"description": "Used to search all related info on an entity. Returns all entities that are similar to the query term."
},
{
"name": "sort",
"value": "",
"type": "query",
"description": "Sort the returned list by a chosen field. Use a '-' before the field name to sort in descending order."
}
],
"auth": {
"type": "basic",
"username": "{{username}}",
"password": "{{password}}"
}
},
"docs": "Get a list of all contacts and associated data in your Nutshell Instance, in a list item format. List items have additional fields attached to them for filtering purposes. Contacts are people that you do business with, and are referred to as 'People' in the Nutshell UI."
},
{
"info": {
"name": "Get the fields for a contact",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://app.nutshell.com/rest/contacts/list/fields",
"auth": {
"type": "basic",
"username": "{{username}}",
"password": "{{password}}"
}
},
"docs": "Get the list of fields that can possibly be associated with contacts, along with whether they are valid for filtering sorting."
}
]
}
],
"bundled": true
}