Contacts

Get all contacts.

GEThttps://api.usepylon.com/contacts

Response

200400404500

Body

application/json

dataarray of Contact (object)

The data payload of the response.

paginationPagination (object)

request_idstring

The request ID for tracking.

Request

JavaScriptCurlPython

const response = await fetch('https://api.usepylon.com/contacts', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400404500

{
  "data": [
    {
      "account": {
        "id": "text"
      },
      "avatar_url": "text",
      "email": "text",
      "emails": [
        "text"
      ],
      "id": "text",
      "name": "text",
      "portal_role": "no_access"
    }
  ],
  "pagination": {
    "cursor": "text",
    "has_next_page": false
  },
  "request_id": "text"
}

Create a new contact.

POSThttps://api.usepylon.com/contacts

Body

application/json

account_idstring

The account that this contact belongs to.

avatar_urlstring

The avatar URL of the contact. Must be a square .png, .jpg or .jpeg.

custom_fieldsarray of CustomFieldValue (object)

An array of custom fields to be applied to this contact.

email*string

The email of the contact.

name*string

The name of the contact.

portal_roleenum

The portal role to assign to the contact. If not provided uses the default portal role from the portal settings.

• no_access PortalRoleNoAccess

• member PortalRoleMember

• admin PortalRoleAdmin

no_accessmemberadmin

Response

200400404500

Body

application/json

dataContact (object)

request_idstring

The request ID for tracking.

Request

JavaScriptCurlPython

const response = await fetch('https://api.usepylon.com/contacts', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "email": "text",
      "name": "text"
    }),
});
const data = await response.json();

Response

200400404500

{
  "data": {
    "account": {
      "id": "text"
    },
    "avatar_url": "text",
    "email": "text",
    "emails": [
      "text"
    ],
    "id": "text",
    "name": "text",
    "portal_role": "no_access"
  },
  "request_id": "text"
}

Get a contact by its ID.

GEThttps://api.usepylon.com/contacts/{id}

Path parameters

id*string

The ID of the contact.

Query parameters

Response

200400404500

Body

application/json

dataContact (object)

request_idstring

The request ID for tracking.

Request

JavaScriptCurlPython

const response = await fetch('https://api.usepylon.com/contacts/{id}?limit=0', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400404500

{
  "data": {
    "account": {
      "id": "text"
    },
    "avatar_url": "text",
    "email": "text",
    "emails": [
      "text"
    ],
    "id": "text",
    "name": "text",
    "portal_role": "no_access"
  },
  "request_id": "text"
}

Update an existing contact.

PATCHhttps://api.usepylon.com/contacts/{id}

Path parameters

id*string

The ID of the contact to update.

Body

application/json

avatar_urlstring

The avatar URL of the contact. Must be a square .png, .jpg or .jpeg.

custom_fieldsarray of CustomFieldValue (object)

An array of custom fields to be applied to this contact.

emailstring

The email of the contact.

namestring

in: body

The name of the contact.

portal_roleenum

The portal role to assign to the contact. Can be one of no_access, member, or admin.

• no_access PortalRoleNoAccess

• member PortalRoleMember

• admin PortalRoleAdmin

no_accessmemberadmin

Response

200400404500

Body

application/json

dataContact (object)

request_idstring

The request ID for tracking.

Request

JavaScriptCurlPython

const response = await fetch('https://api.usepylon.com/contacts/{id}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400404500

{
  "data": {
    "account": {
      "id": "text"
    },
    "avatar_url": "text",
    "email": "text",
    "emails": [
      "text"
    ],
    "id": "text",
    "name": "text",
    "portal_role": "no_access"
  },
  "request_id": "text"
}

Search for contacts by a given filter.

Currently, the following fields are filterable for contacts:

• id

• email

• custom fields (pass in the slug of the custom field)

POSThttps://api.usepylon.com/contacts/search

Body

application/json

cursorstring

The cursor to use for pagination.

filter*Filter (object)

limitinteger (int64)

The number of contacts to fetch. Defaults to 100. Must be greater than 0 and less than 1000.

Response

200

Body

application/json

dataarray of Contact (object)

The data payload of the response.

paginationPagination (object)

request_idstring

The request ID for tracking.

Request

JavaScriptCurlPython

const response = await fetch('https://api.usepylon.com/contacts/search', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "filter": {
        "field": "text",
        "operator": "equals"
      }
    }),
});
const data = await response.json();

Response

200

{
  "data": [
    {
      "account": {
        "id": "text"
      },
      "avatar_url": "text",
      "email": "text",
      "emails": [
        "text"
      ],
      "id": "text",
      "name": "text",
      "portal_role": "no_access"
    }
  ],
  "pagination": {
    "cursor": "text",
    "has_next_page": false
  },
  "request_id": "text"
}